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
Methods
__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}"
Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {
| 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}"
Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {
| 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
Generated from protobuf field string filter = 2;
| 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
Generated from protobuf field string filter = 2;
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getPageSize
Page size.
Generated from protobuf field int32 page_size = 3;
| Returns | |
|---|---|
| Type | Description |
int | |
setPageSize
Page size.
Generated from protobuf field int32 page_size = 3;
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getPageToken
Page token.
Generated from protobuf field string page_token = 4;
| Returns | |
|---|---|
| Type | Description |
string | |
setPageToken
Page token.
Generated from protobuf field string page_token = 4;
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |