Reference documentation and code samples for the Google Cloud Run V2 Client class ListTasksRequest.
Request message for retrieving a list of Tasks.
Generated from protobuf message google.cloud.run.v2.ListTasksRequest
Namespace
Google \ Cloud \ Run \ V2Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ parent |
string
Required. The Execution from which the Tasks should be listed. To list all Tasks across Executions of a Job, use "-" instead of Execution name. To list all Tasks across Jobs, use "-" instead of Job name. Format: projects/{project}/locations/{location}/jobs/{job}/executions/{execution} |
↳ page_size |
int
Maximum number of Tasks to return in this call. |
↳ page_token |
string
A page token received from a previous call to ListTasks. All other parameters must match. |
↳ show_deleted |
bool
If true, returns deleted (but unexpired) resources along with active ones. |
getParent
Required. The Execution from which the Tasks should be listed.
To list all Tasks across Executions of a Job, use "-" instead of Execution name. To list all Tasks across Jobs, use "-" instead of Job name. Format: projects/{project}/locations/{location}/jobs/{job}/executions/{execution}
| Returns | |
|---|---|
| Type | Description |
string | |
setParent
Required. The Execution from which the Tasks should be listed.
To list all Tasks across Executions of a Job, use "-" instead of Execution name. To list all Tasks across Jobs, use "-" instead of Job name. Format: projects/{project}/locations/{location}/jobs/{job}/executions/{execution}
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getPageSize
Maximum number of Tasks to return in this call.
| Returns | |
|---|---|
| Type | Description |
int | |
setPageSize
Maximum number of Tasks to return in this call.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getPageToken
A page token received from a previous call to ListTasks.
All other parameters must match.
| Returns | |
|---|---|
| Type | Description |
string | |
setPageToken
A page token received from a previous call to ListTasks.
All other parameters must match.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getShowDeleted
If true, returns deleted (but unexpired) resources along with active ones.
| Returns | |
|---|---|
| Type | Description |
bool | |
setShowDeleted
If true, returns deleted (but unexpired) resources along with active ones.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this | |
static::build
| Parameter | |
|---|---|
| Name | Description |
parent |
string
Required. The Execution from which the Tasks should be listed. To list all Tasks across Executions of a Job, use "-" instead of Execution name. To list all Tasks across Jobs, use "-" instead of Job name. Format: projects/{project}/locations/{location}/jobs/{job}/executions/{execution} Please see Google\Cloud\Run\V2\TasksClient::executionName() for help formatting this field. |
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Run\V2\ListTasksRequest | |