get method

Future<Task> get(
  1. String name, {
  2. String? responseView,
  3. String? $fields,
})

Gets a task.

Request parameters:

name - Required. The task name. For example: projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID Value must have pattern ^projects/\[^/\]+/locations/\[^/\]+/queues/\[^/\]+/tasks/\[^/\]+$.

responseView - The response_view specifies which subset of the Task will be returned. By default response_view is BASIC; not all information is retrieved by default because some data, such as payloads, might be desirable to return only when needed because of its large size or because of the sensitivity of data that it contains. Authorization for FULL requires cloudtasks.tasks.fullView Google IAM permission on the Task resource. Possible string values are:

  • "VIEW_UNSPECIFIED" : Unspecified. Defaults to BASIC.
  • "BASIC" : The basic view omits fields which can be large or can contain sensitive data. This view does not include the body in AppEngineHttpRequest. Bodies are desirable to return only when needed, because they can be large and because of the sensitivity of the data that you choose to store in it.
  • "FULL" : All information is returned. Authorization for FULL requires cloudtasks.tasks.fullView Google IAM permission on the Queue resource.

$fields - Selector specifying which fields to include in a partial response.

Completes with a Task.

Completes with a commons.ApiRequestError if the API endpoint returned an error.

If the used http.Client completes with an error when making a REST call, this method will complete with the same error.

Implementation

async.Future<Task> get(
  core.String name, {
  core.String? responseView,
  core.String? $fields,
}) async {
  final queryParams_ = <core.String, core.List<core.String>>{
    if (responseView != null) 'responseView': [responseView],
    if ($fields != null) 'fields': [$fields],
  };

  final url_ = 'v2/' + core.Uri.encodeFull('$name');

  final response_ = await _requester.request(
    url_,
    'GET',
    queryParams: queryParams_,
  );
  return Task.fromJson(response_ as core.Map<core.String, core.dynamic>);
}