Reference documentation and code samples for the Google Cloud Batch V1 Client class ListTasksRequest.
ListTasks Request.
Generated from protobuf message google.cloud.batch.v1.ListTasksRequest
Namespace
Google \ Cloud \ Batch \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ parent |
string
Required. Name of a TaskGroup from which Tasks are being requested. Pattern: "projects/{project}/locations/{location}/jobs/{job}/taskGroups/{task_group}" |
↳ filter |
string
Task filter, null filter matches all Tasks. Filter string should be of the format State=TaskStatus.State e.g. State=RUNNING |
↳ page_size |
int
Page size. |
↳ page_token |
string
Page token. |
getParent
Required. Name of a TaskGroup from which Tasks are being requested.
Pattern: "projects/{project}/locations/{location}/jobs/{job}/taskGroups/{task_group}"
| Returns | |
|---|---|
| Type | Description |
string | |
setParent
Required. Name of a TaskGroup from which Tasks are being requested.
Pattern: "projects/{project}/locations/{location}/jobs/{job}/taskGroups/{task_group}"
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getFilter
Task filter, null filter matches all Tasks.
Filter string should be of the format State=TaskStatus.State e.g. State=RUNNING
| Returns | |
|---|---|
| Type | Description |
string | |
setFilter
Task filter, null filter matches all Tasks.
Filter string should be of the format State=TaskStatus.State e.g. State=RUNNING
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getPageSize
Page size.
| Returns | |
|---|---|
| Type | Description |
int | |
setPageSize
Page size.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getPageToken
Page token.
| Returns | |
|---|---|
| Type | Description |
string | |
setPageToken
Page token.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
static::build
| Parameter | |
|---|---|
| Name | Description |
parent |
string
Required. Name of a TaskGroup from which Tasks are being requested. Pattern: "projects/{project}/locations/{location}/jobs/{job}/taskGroups/{task_group}" Please see Google\Cloud\Batch\V1\BatchServiceClient::taskGroupName() for help formatting this field. |
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Batch\V1\ListTasksRequest | |