setProgress method

Future<DynamiteResponse<TaskProcessingApiSetProgressResponseApplicationJson, void>> setProgress({ required int taskId, required TaskProcessingApiSetProgressRequestApplicationJson $body, bool? oCSAPIRequest, })

Sets the task progress.

This endpoint requires admin access.

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:

• taskId The id of the task.
• oCSAPIRequest Required to be true for the API request to pass. Defaults to true.

Status codes:

• 200: Progress updated successfully
• 500
• 404: Task not found

See:

• $setProgress_Request for the request send by this method.
• $setProgress_Serializer for a converter to parse the Response from an executed request.

Implementation

Future<_i1.DynamiteResponse<TaskProcessingApiSetProgressResponseApplicationJson, void>> setProgress({
  required int taskId,
  required TaskProcessingApiSetProgressRequestApplicationJson $body,
  bool? oCSAPIRequest,
}) async {
  final _request = $setProgress_Request(
    taskId: taskId,
    oCSAPIRequest: oCSAPIRequest,
    $body: $body,
  );
  final _streamedResponse = await _rootClient.httpClient.send(_request);
  final _response = await _i3.Response.fromStream(_streamedResponse);

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