JobsApi class

Constructors

JobsApi(Dio _dio, Serializers _serializers)

const

Properties

hashCode → int

The hash code for this object.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

cancelJob({required String jobId, CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<StatusOK>>

Cancel a job. Cancel a job. Minimum server version: 4.1 ##### Permissions Must have `manage_jobs` permission.

createJob({required InlineObject66 inlineObject66, CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<Job>>

Create a new job. Create a new job. Minimum server version: 4.1 ##### Permissions Must have `manage_jobs` permission.

downloadJob({required String jobId, CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<void>>

Download the results of a job. Download the result of a single job. Minimum server version: 5.28 ##### Permissions Must have `manage_jobs` permission.

getJob({required String jobId, CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<Job>>

Get a job. Gets a single job. Minimum server version: 4.1 ##### Permissions Must have `manage_jobs` permission.

getJobs({int? page = 0, int? perPage = 60, CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<BuiltList<Job>>>

Get the jobs. Get a page of jobs. Use the query parameters to modify the behaviour of this endpoint. Minimum server version: 4.1 ##### Permissions Must have `manage_jobs` permission.

getJobsByType({required String type, int? page = 0, int? perPage = 60, CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<BuiltList<Job>>>

Get the jobs of the given type. Get a page of jobs of the given type. Use the query parameters to modify the behaviour of this endpoint. Minimum server version: 4.1 ##### Permissions Must have `manage_jobs` permission.

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited