Google Cloud Batch V1 Client - Class ListTasksRequest (0.11.3)

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 \ V1

Methods

__construct

Constructor.

Parameters
NameDescription
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
TypeDescription
string

setParent

Required. Name of a TaskGroup from which Tasks are being requested.

Pattern: "projects/{project}/locations/{location}/jobs/{job}/taskGroups/{task_group}"

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getFilter

Task filter, null filter matches all Tasks.

Filter string should be of the format State=TaskStatus.State e.g. State=RUNNING

Returns
TypeDescription
string

setFilter

Task filter, null filter matches all Tasks.

Filter string should be of the format State=TaskStatus.State e.g. State=RUNNING

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getPageSize

Page size.

Returns
TypeDescription
int

setPageSize

Page size.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getPageToken

Page token.

Returns
TypeDescription
string

setPageToken

Page token.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

static::build

Parameter
NameDescription
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
TypeDescription
Google\Cloud\Batch\V1\ListTasksRequest