`flywheel.api.jobs_api`

`JobsApi`

Bases: object

`add_job(body, **kwargs)`

Add a job

This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`body`	`InputJob`		required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`add_job_logs(job_id, body, **kwargs)`

Add logs to a job.

This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`job_id`	`str`		required
`body`	`list[JobLog]`		required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`add_job_logs_with_http_info(job_id, body, **kwargs)`

Add logs to a job.

This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`job_id`	`str`		required
`body`	`list[JobLog]`		required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`add_job_with_http_info(body, **kwargs)`

Add a job

This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`body`	`InputJob`		required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`ask_jobs(body, **kwargs)`

Ask the queue a question

Ask the queue a question, receiving work or statistics in return. This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`body`	`JobAsk`		required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`ask_jobs_state(job_state, body, **kwargs)`

Ask job count by state

Ask the queue for the number of jobs for a given state and query. This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`job_state`	`JobState`		required
`body`	`JobAsk`		required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`ask_jobs_state_with_http_info(job_state, body, **kwargs)`

Ask job count by state

Ask the queue for the number of jobs for a given state and query. This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`job_state`	`JobState`		required
`body`	`JobAsk`		required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`ask_jobs_with_http_info(body, **kwargs)`

Ask the queue a question

Ask the queue a question, receiving work or statistics in return. This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`body`	`JobAsk`		required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`complete_job(job_id, body, **kwargs)`

Complete a job, with information

This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`job_id`	`str`		required
`body`	`JobComplete`		required
`job_ticket_id`	`(str, optional)`	ticket id for job completion	required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`complete_job_with_http_info(job_id, body, **kwargs)`

Complete a job, with information

This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`job_id`	`str`		required
`body`	`JobComplete`		required
`job_ticket_id`	`(str, optional)`	ticket id for job completion	required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`determine_provider_for_job(body, **kwargs)`

Determine the effective compute provider for a proposed job.

This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`body`	`InputJob`		required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`determine_provider_for_job_with_http_info(body, **kwargs)`

Determine the effective compute provider for a proposed job.

This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`body`	`InputJob`		required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`engine_complete_job(job_id, body, **kwargs)`

Complete a job, with information.

This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`job_id`	`str`		required
`body`	`JobComplete`		required
`job_ticket_id`	`(str, optional)`	ticket id for job completion	required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`engine_complete_job_with_http_info(job_id, body, **kwargs)`

Complete a job, with information.

This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`job_id`	`str`		required
`body`	`JobComplete`		required
`job_ticket_id`	`(str, optional)`	ticket id for job completion	required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`engine_prepare_complete_job(job_id, **kwargs)`

Create a ticket for completing a job, with id and status.

This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`job_id`	`str`		required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`engine_prepare_complete_job_with_http_info(job_id, **kwargs)`

Create a ticket for completing a job, with id and status.

This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`job_id`	`str`		required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`get_all_jobs(**kwargs)`

Return all jobs

This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`include_parent_info`	`(bool, optional)`	Include the parent info for the jobs, defaults to false	required
`include_all_info`	`(bool, optional)`	Include all info in returned objects, defaults to false	required
`filter`	`(str, optional)`	Comma separated filters to apply. Commas not used as separators must be escaped with backslash '\'. (e.g. label=my-label,created>2018-09-22)	required
`sort`	`(str, optional)`	The sort fields and order. (e.g. label:asc,created:desc)	required
`limit`	`(int, optional)`	The maximum number of entries to return.	required
`skip`	`(int, optional)`	The number of entries to skip., defaults to 0	required
`page`	`(int, optional)`	The page number (i.e. skip limit*page entries)	required
`after_id`	`(str, optional)`	Paginate after the given id. (Cannot be used with sort, page or skip)	required
`x_accept_feature`	`(list[str], optional)`	, defaults to []	required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`get_all_jobs_with_http_info(**kwargs)`

Return all jobs

This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`include_parent_info`	`(bool, optional)`	Include the parent info for the jobs, defaults to false	required
`include_all_info`	`(bool, optional)`	Include all info in returned objects, defaults to false	required
`filter`	`(str, optional)`	Comma separated filters to apply. Commas not used as separators must be escaped with backslash '\'. (e.g. label=my-label,created>2018-09-22)	required
`sort`	`(str, optional)`	The sort fields and order. (e.g. label:asc,created:desc)	required
`limit`	`(int, optional)`	The maximum number of entries to return.	required
`skip`	`(int, optional)`	The number of entries to skip., defaults to 0	required
`page`	`(int, optional)`	The page number (i.e. skip limit*page entries)	required
`after_id`	`(str, optional)`	Paginate after the given id. (Cannot be used with sort, page or skip)	required
`x_accept_feature`	`(list[str], optional)`	, defaults to []	required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`get_job(job_id, **kwargs)`

Get job details

This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`job_id`	`str`		required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`get_job_config(job_id, **kwargs)`

Get a job's config

This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`job_id`	`str`		required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`get_job_config_with_http_info(job_id, **kwargs)`

Get a job's config

This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`job_id`	`str`		required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`get_job_detail(job_id, **kwargs)`

Get job container details

This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`job_id`	`str`		required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`get_job_detail_with_http_info(job_id, **kwargs)`

Get job container details

This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`job_id`	`str`		required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`get_job_logs(job_id, **kwargs)`

Get job logs

This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`job_id`	`str`		required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`get_job_logs_with_http_info(job_id, **kwargs)`

Get job logs

This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`job_id`	`str`		required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`get_job_with_http_info(job_id, **kwargs)`

Get job details

This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`job_id`	`str`		required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`get_jobs_stats(**kwargs)`

Get stats about all current jobs

This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`get_jobs_stats_with_http_info(**kwargs)`

Get stats about all current jobs

This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`get_next_job(**kwargs)`

Get the next job in the queue

Used by the engine. This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`tags`	`(list[str], optional)`		required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`get_next_job_with_http_info(**kwargs)`

Get the next job in the queue

Used by the engine. This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`tags`	`(list[str], optional)`		required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`heartbeat_job(job_id, **kwargs)`

Heartbeat a running job to update its modified timestamp.

Updates the modified timestamp for a running job without changing its state. Used by engines to keep jobs alive. This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`job_id`	`str`		required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`heartbeat_job_with_http_info(job_id, **kwargs)`

Heartbeat a running job to update its modified timestamp.

Updates the modified timestamp for a running job without changing its state. Used by engines to keep jobs alive. This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`job_id`	`str`		required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`modify_job(job_id, body, **kwargs)`

Update a job.

Updates timestamp. Enforces a valid state machine transition, if any. Rejects any change to a job that is not currently in 'pending' or 'running' state. Accepts the same body as /api/jobs/add, except all fields are optional. This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`job_id`	`str`		required
`body`	`JobModify`		required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`modify_job_with_http_info(job_id, body, **kwargs)`

Update a job.

Updates timestamp. Enforces a valid state machine transition, if any. Rejects any change to a job that is not currently in 'pending' or 'running' state. Accepts the same body as /api/jobs/add, except all fields are optional. This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`job_id`	`str`		required
`body`	`JobModify`		required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`prepare_complete_job(job_id, **kwargs)`

Create a ticket for completing a job, with id and status.

This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`job_id`	`str`		required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`prepare_complete_job_with_http_info(job_id, **kwargs)`

Create a ticket for completing a job, with id and status.

This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`job_id`	`str`		required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`reap_jobs(**kwargs)`

Reap stale jobs

This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`reap_jobs_with_http_info(**kwargs)`

Reap stale jobs

This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`retry_job(job_id, **kwargs)`

Retry a job.

The job must have a state of 'failed', and must not have already been retried. The failed jobs config is copied to a new job. The ID of the new job is returned. This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`job_id`	`str`		required
`compute_provider_id`	`(str, optional)`		required
`ignore_state`	`(bool, optional)`	, defaults to false	required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`retry_job_with_http_info(job_id, **kwargs)`

Retry a job.

The job must have a state of 'failed', and must not have already been retried. The failed jobs config is copied to a new job. The ID of the new job is returned. This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`job_id`	`str`		required
`compute_provider_id`	`(str, optional)`		required
`ignore_state`	`(bool, optional)`	, defaults to false	required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`update_job_profile(job_id, body, **kwargs)`

Update profile information on a job. (e.g. machine type, etc)

This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`job_id`	`str`		required
`body`	`InputJobProfile`		required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`update_job_profile_with_http_info(job_id, body, **kwargs)`

Update profile information on a job. (e.g. machine type, etc)

This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`job_id`	`str`		required
`body`	`InputJobProfile`		required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`update_jobs_priority(body, **kwargs)`

Update a job priority.

This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`body`	`JobPriorityUpdate`		required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`update_jobs_priority_with_http_info(body, **kwargs)`

Update a job priority.

This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`body`	`JobPriorityUpdate`		required
`async_`	`(bool, optional)`	Perform the request asynchronously	required