Reference documentation and code samples for the Google Cloud Tasks V2 Client class GetTaskRequest.
Request message for getting a task using GetTask.
Generated from protobuf message google.cloud.tasks.v2.GetTaskRequest
Namespace
Google \ Cloud \ Tasks \ V2Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Required. The task name. For example: |
↳ response_view |
int
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 |
getName
Required. The task name. For example:
projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID
| Returns | |
|---|---|
| Type | Description |
string | |
setName
Required. The task name. For example:
projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getResponseView
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.
| Returns | |
|---|---|
| Type | Description |
int | |
setResponseView
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.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
static::build
| Parameter | |
|---|---|
| Name | Description |
name |
string
Required. The task name. For example:
|
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Tasks\V2\GetTaskRequest | |