`flywheel.api.batch_api`

`BatchApi`

Bases: object

`cancel_batch(batch_id, **kwargs)`

Cancel a Job

Cancels jobs that are still pending, returns number of jobs cancelled. Moves a 'running' batch job to 'cancelled'. This method makes a synchronous HTTP request by default.

Parameters:

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

`cancel_batch_with_http_info(batch_id, **kwargs)`

Cancel a Job

Cancels jobs that are still pending, returns number of jobs cancelled. Moves a 'running' batch job to 'cancelled'. This method makes a synchronous HTTP request by default.

Parameters:

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

`create_batch_job_from_jobs(body, **kwargs)`

Create a batch job proposal from preconstructed jobs and insert it as 'pending'.

Create a batch job proposal from preconstructed jobs and insert it as 'pending'. This method makes a synchronous HTTP request by default.

Parameters:

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

`create_batch_job_from_jobs_with_http_info(body, **kwargs)`

Create a batch job proposal from preconstructed jobs and insert it as 'pending'.

Create a batch job proposal from preconstructed jobs and insert it as 'pending'. This method makes a synchronous HTTP request by default.

Parameters:

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

`get_all_batches(**kwargs)`

Get a list of batch jobs the user has created.

Requires login. This method makes a synchronous HTTP request by default.

Parameters:

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

`get_all_batches_with_http_info(**kwargs)`

Get a list of batch jobs the user has created.

Requires login. This method makes a synchronous HTTP request by default.

Parameters:

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

`get_batch(batch_id, **kwargs)`

Get batch job details.

This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`batch_id`	`str`		required
`jobs`	`(bool, optional)`	If true, return job objects instead of job ids, defaults to false	required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`get_batch_with_http_info(batch_id, **kwargs)`

Get batch job details.

This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`batch_id`	`str`		required
`jobs`	`(bool, optional)`	If true, return job objects instead of job ids, defaults to false	required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`propose_batch(body, **kwargs)`

Create a batch job proposal and insert it as 'pending'.

This method makes a synchronous HTTP request by default.

Parameters:

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

`propose_batch_with_http_info(body, **kwargs)`

Create a batch job proposal and insert it as 'pending'.

This method makes a synchronous HTTP request by default.

Parameters:

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

`start_batch(batch_id, **kwargs)`

Launch a job.

Creates jobs from proposed inputs, returns jobs enqueued. Moves 'pending' batch job to 'running'. This method makes a synchronous HTTP request by default.

Parameters:

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

`start_batch_with_http_info(batch_id, **kwargs)`

Launch a job.

Creates jobs from proposed inputs, returns jobs enqueued. Moves 'pending' batch job to 'running'. This method makes a synchronous HTTP request by default.

Parameters:

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