Gets a task.
Arguments
Parameters | |
---|---|
name |
Required. The task name. For example:
|
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
|
Enum type. Can be one of the following: | |
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. |
Raised exceptions
Exceptions | |
---|---|
ConnectionError |
In case of a network problem (such as DNS failure or refused connection). |
HttpError |
If the response status is >= 400 (excluding 429 and 503). |
TimeoutError |
If a long-running operation takes longer to finish than the specified timeout limit. |
TypeError |
If an operation or function receives an argument of the wrong type. |
ValueError |
If an operation or function receives an argument of the right type but an inappropriate value. For example, a negative timeout. |
Response
If successful, the response contains an instance of Task
.
Subworkflow snippet
Some fields might be optional or required. To identify required fields, refer to the API documentation.
YAML
- get: call: googleapis.cloudtasks.v2beta3.projects.locations.queues.tasks.get args: name: ... responseView: ... result: getResult
JSON
[ { "get": { "call": "googleapis.cloudtasks.v2beta3.projects.locations.queues.tasks.get", "args": { "name": "...", "responseView": "..." }, "result": "getResult" } } ]