schedule method

Future<DynamiteResponse<TaskProcessingApiScheduleResponseApplicationJson, void>> schedule({
  1. required TaskProcessingApiScheduleRequestApplicationJson $body,
  2. bool? oCSAPIRequest,
})

Schedules a task.

Returns a Future containing a DynamiteResponse with the status code, deserialized body and headers. Throws a DynamiteApiException if the API call does not return an expected status code.

Parameters:

  • oCSAPIRequest Required to be true for the API request to pass. Defaults to true.

Status codes:

  • 200: Task scheduled successfully
  • 500
  • 400: Scheduling task is not possible
  • 412: Scheduling task is not possible
  • 401: Cannot schedule task because it references files in its input that the user doesn't have access to

See:

Implementation

Future<_i1.DynamiteResponse<TaskProcessingApiScheduleResponseApplicationJson, void>> schedule({
  required TaskProcessingApiScheduleRequestApplicationJson $body,
  bool? oCSAPIRequest,
}) async {
  final _request = $schedule_Request(
    oCSAPIRequest: oCSAPIRequest,
    $body: $body,
  );
  final _streamedResponse = await _rootClient.httpClient.send(_request);
  final _response = await _i3.Response.fromStream(_streamedResponse);

  final _serializer = $schedule_Serializer();
  return _i1.ResponseConverter<TaskProcessingApiScheduleResponseApplicationJson, void>(_serializer)
      .convert(_response);
}