Reference documentation and code samples for the Google Cloud Tasks V2 Client class ListTasksRequest.
Request message for listing tasks using ListTasks .
Generated from protobuf message google.cloud.tasks.v2.ListTasksRequest
Namespace
Google \ Cloud \ Tasks \ V2Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ parent
string
Required. The queue name. For example: projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID
↳ 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 cloudtasks.tasks.fullView
Google IAM
permission on the Task
resource.
↳ page_size
int
Maximum page size. Fewer tasks than requested might be returned, even if more tasks exist; use next_page_token in the response to determine if more tasks exist. The maximum page size is 1000. If unspecified, the page size will be the maximum.
↳ page_token
string
A token identifying the page of results to return. To request the first page results, page_token must be empty. To request the next page of results, page_token must be the value of next_page_token returned from the previous call to ListTasks method. The page token is valid for only 2 hours.
getParent
Required. The queue name. For example: projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID
string
setParent
Required. The queue name. For example: projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID
var
string
$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.
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.
var
int
$this
getPageSize
Maximum page size.
Fewer tasks than requested might be returned, even if more tasks exist; use next_page_token in the response to determine if more tasks exist. The maximum page size is 1000. If unspecified, the page size will be the maximum.
int
setPageSize
Maximum page size.
Fewer tasks than requested might be returned, even if more tasks exist; use next_page_token in the response to determine if more tasks exist. The maximum page size is 1000. If unspecified, the page size will be the maximum.
var
int
$this
getPageToken
A token identifying the page of results to return.
To request the first page results, page_token must be empty. To request the next page of results, page_token must be the value of next_page_token returned from the previous call to ListTasks method. The page token is valid for only 2 hours.
string
setPageToken
A token identifying the page of results to return.
To request the first page results, page_token must be empty. To request the next page of results, page_token must be the value of next_page_token returned from the previous call to ListTasks method. The page token is valid for only 2 hours.
var
string
$this
static::build
parent
string
Required. The queue name. For example: projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID
Please see Google\Cloud\Tasks\V2\CloudTasksClient::queueName()
for help formatting this field.
