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
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getStatus
Task Status.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Batch\V1\TaskStatus|null | |
hasStatus
clearStatus
setStatus
Task Status.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Batch\V1\TaskStatus
|
| Returns | |
|---|---|
| Type | Description |
$this | |