queueflow.CronApi

All URIs are relative to http://localhost:8000

Method	HTTP request	Description
create_cron	POST /api/v1/cron
delete_cron	DELETE /api/v1/cron/{id}
get_cron	GET /api/v1/cron/{id}
list_crons	GET /api/v1/cron
pause_cron	POST /api/v1/cron/{id}/pause
resume_cron	POST /api/v1/cron/{id}/resume

create_cron

CreateCronResponse create_cron(create_cron_request)

Example

Bearer (API Key) Authentication (bearerAuth):

import queueflow
from queueflow.models.create_cron_request import CreateCronRequest
from queueflow.models.create_cron_response import CreateCronResponse
from queueflow.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:8000
# See configuration.py for a list of all supported configuration parameters.
configuration = queueflow.Configuration(
    host = "http://localhost:8000"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (API Key): bearerAuth
configuration = queueflow.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with queueflow.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = queueflow.CronApi(api_client)
    create_cron_request = queueflow.CreateCronRequest() # CreateCronRequest | 

    try:
        api_response = api_instance.create_cron(create_cron_request)
        print("The response of CronApi->create_cron:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling CronApi->create_cron: %s\n" % e)

Parameters

Name	Type	Description	Notes
create_cron_request	CreateCronRequest

Return type

CreateCronResponse

Authorization

bearerAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
201	Schedule created; first firing is the next occurrence (UTC)	-
400	Invalid request (e.g. a bad cron expression)	-
401	Unauthorized	-
409	A schedule with this name already exists	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_cron

delete_cron(id)

Example

Bearer (API Key) Authentication (bearerAuth):

import queueflow
from queueflow.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:8000
# See configuration.py for a list of all supported configuration parameters.
configuration = queueflow.Configuration(
    host = "http://localhost:8000"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (API Key): bearerAuth
configuration = queueflow.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with queueflow.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = queueflow.CronApi(api_client)
    id = 'id_example' # str | Cron schedule id

    try:
        api_instance.delete_cron(id)
    except Exception as e:
        print("Exception when calling CronApi->delete_cron: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str	Cron schedule id

Return type

void (empty response body)

Authorization

bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
204	Deleted; already-enqueued jobs are unaffected	-
401	Unauthorized	-
403	Forbidden	-
404	Not found	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_cron

CronSchedule get_cron(id)

Example

Bearer (API Key) Authentication (bearerAuth):

import queueflow
from queueflow.models.cron_schedule import CronSchedule
from queueflow.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:8000
# See configuration.py for a list of all supported configuration parameters.
configuration = queueflow.Configuration(
    host = "http://localhost:8000"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (API Key): bearerAuth
configuration = queueflow.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with queueflow.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = queueflow.CronApi(api_client)
    id = 'id_example' # str | Cron schedule id

    try:
        api_response = api_instance.get_cron(id)
        print("The response of CronApi->get_cron:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling CronApi->get_cron: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str	Cron schedule id

Return type

CronSchedule

Authorization

bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Cron schedule	-
401	Unauthorized	-
403	Forbidden	-
404	Not found	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

list_crons

ListCronsResponse list_crons(status=status, queue=queue, task_name=task_name, replayed=replayed, limit=limit, offset=offset, order_by=order_by, include_total=include_total, cursor=cursor, created_after=created_after, created_before=created_before)

Example

Bearer (API Key) Authentication (bearerAuth):

import queueflow
from queueflow.models.list_crons_response import ListCronsResponse
from queueflow.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:8000
# See configuration.py for a list of all supported configuration parameters.
configuration = queueflow.Configuration(
    host = "http://localhost:8000"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (API Key): bearerAuth
configuration = queueflow.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with queueflow.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = queueflow.CronApi(api_client)
    status = 'status_example' # str | Filter by status (e.g. `pending`, `completed`). (optional)
    queue = 'queue_example' # str | Filter by queue name (jobs only). (optional)
    task_name = 'task_name_example' # str | Filter by task name (jobs and dead letters). (optional)
    replayed = True # bool | Dead letters only: `false` lists entries not yet replayed, `true` the replayed ones; both when omitted. (optional)
    limit = 56 # int | Page size, 1..=100 (default 50). (optional)
    offset = 56 # int | Number of records to skip (default 0). (optional)
    order_by = 'order_by_example' # str | `created_at ASC` or `created_at DESC` (default DESC). (optional)
    include_total = True # bool | Include the exact `total` count in the response (default false; the count is an extra full scan over the filtered set). (optional)
    cursor = 'cursor_example' # str | Opaque keyset cursor from a previous page's `next_cursor`. When set, `offset` is ignored and listing continues where that page ended. (optional)
    created_after = '2013-10-20T19:20:30+01:00' # datetime | Only rows created at or after this instant (RFC 3339, inclusive). With `created_before` this forms the half-open range `[after, before)` — the natural shape for walking history period by period. (optional)
    created_before = '2013-10-20T19:20:30+01:00' # datetime | Only rows created strictly before this instant (RFC 3339, exclusive). (optional)

    try:
        api_response = api_instance.list_crons(status=status, queue=queue, task_name=task_name, replayed=replayed, limit=limit, offset=offset, order_by=order_by, include_total=include_total, cursor=cursor, created_after=created_after, created_before=created_before)
        print("The response of CronApi->list_crons:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling CronApi->list_crons: %s\n" % e)

Parameters

Name	Type	Description	Notes
status	str	Filter by status (e.g. `pending`, `completed`).	[optional]
queue	str	Filter by queue name (jobs only).	[optional]
task_name	str	Filter by task name (jobs and dead letters).	[optional]
replayed	bool	Dead letters only: `false` lists entries not yet replayed, `true` the replayed ones; both when omitted.	[optional]
limit	int	Page size, 1..=100 (default 50).	[optional]
offset	int	Number of records to skip (default 0).	[optional]
order_by	str	`created_at ASC` or `created_at DESC` (default DESC).	[optional]
include_total	bool	Include the exact `total` count in the response (default false; the count is an extra full scan over the filtered set).	[optional]
cursor	str	Opaque keyset cursor from a previous page's `next_cursor`. When set, `offset` is ignored and listing continues where that page ended.	[optional]
created_after	datetime	Only rows created at or after this instant (RFC 3339, inclusive). With `created_before` this forms the half-open range `[after, before)` — the natural shape for walking history period by period.	[optional]
created_before	datetime	Only rows created strictly before this instant (RFC 3339, exclusive).	[optional]

Return type

ListCronsResponse

Authorization

bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Page of cron schedules (`status`/`queue` filters do not apply)	-
401	Unauthorized	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

pause_cron

pause_cron(id)

Example

Bearer (API Key) Authentication (bearerAuth):

import queueflow
from queueflow.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:8000
# See configuration.py for a list of all supported configuration parameters.
configuration = queueflow.Configuration(
    host = "http://localhost:8000"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (API Key): bearerAuth
configuration = queueflow.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with queueflow.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = queueflow.CronApi(api_client)
    id = 'id_example' # str | Cron schedule id

    try:
        api_instance.pause_cron(id)
    except Exception as e:
        print("Exception when calling CronApi->pause_cron: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str	Cron schedule id

Return type

void (empty response body)

Authorization

bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
204	Paused: no further firings until resumed	-
401	Unauthorized	-
403	Forbidden	-
404	Not found	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

resume_cron

resume_cron(id)

Example

Bearer (API Key) Authentication (bearerAuth):

import queueflow
from queueflow.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:8000
# See configuration.py for a list of all supported configuration parameters.
configuration = queueflow.Configuration(
    host = "http://localhost:8000"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (API Key): bearerAuth
configuration = queueflow.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with queueflow.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = queueflow.CronApi(api_client)
    id = 'id_example' # str | Cron schedule id

    try:
        api_instance.resume_cron(id)
    except Exception as e:
        print("Exception when calling CronApi->resume_cron: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str	Cron schedule id

Return type

void (empty response body)

Authorization

bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
204	Resumed: fires at its next future occurrence (missed runs are not caught up)	-
401	Unauthorized	-
403	Forbidden	-
404	Not found	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

FilesExpand file tree

CronApi.md

Latest commit

History

CronApi.md

File metadata and controls

queueflow.CronApi

create_cron

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

delete_cron

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_cron

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

list_crons

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

pause_cron

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

resume_cron

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details