Google Cloud Batch V1 Client - Class Task (0.15.0)

Reference documentation and code samples for the Google Cloud Batch V1 Client class Task.

A Cloud Batch task.

Generated from protobuf message google.cloud.batch.v1.Task

Namespace

Google \ Cloud \ Batch \ V1

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ name string

Task name. The name is generated from the parent TaskGroup name and 'id' field. For example: "projects/123456/locations/us-west1/jobs/job01/taskGroups/group01/tasks/task01".

↳ status Google\Cloud\Batch\V1\TaskStatus

Task Status.

getName

Task name.

The name is generated from the parent TaskGroup name and 'id' field. For example: "projects/123456/locations/us-west1/jobs/job01/taskGroups/group01/tasks/task01".

Returns
TypeDescription
string

setName

Task name.

The name is generated from the parent TaskGroup name and 'id' field. For example: "projects/123456/locations/us-west1/jobs/job01/taskGroups/group01/tasks/task01".

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getStatus

Task Status.

Returns
TypeDescription
Google\Cloud\Batch\V1\TaskStatus|null

hasStatus

clearStatus

setStatus

Task Status.

Parameter
NameDescription
var Google\Cloud\Batch\V1\TaskStatus
Returns
TypeDescription
$this