Reference documentation and code samples for the Google Cloud Batch V1 Client class JobStatus.
Job status.
Generated from protobuf message google.cloud.batch.v1.JobStatus
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ state |
int
Job state |
↳ status_events |
array<Google\Cloud\Batch\V1\StatusEvent>
Job status events |
↳ task_groups |
array|Google\Protobuf\Internal\MapField
Aggregated task status for each TaskGroup in the Job. The map key is TaskGroup ID. |
↳ run_duration |
Google\Protobuf\Duration
The duration of time that the Job spent in status RUNNING. |
getState
Job state
Generated from protobuf field .google.cloud.batch.v1.JobStatus.State state = 1;
| Returns | |
|---|---|
| Type | Description |
int | |
setState
Job state
Generated from protobuf field .google.cloud.batch.v1.JobStatus.State state = 1;
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getStatusEvents
Job status events
Generated from protobuf field repeated .google.cloud.batch.v1.StatusEvent status_events = 2;
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField | |
setStatusEvents
Job status events
Generated from protobuf field repeated .google.cloud.batch.v1.StatusEvent status_events = 2;
| Parameter | |
|---|---|
| Name | Description |
var |
array<Google\Cloud\Batch\V1\StatusEvent>
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getTaskGroups
Aggregated task status for each TaskGroup in the Job.
The map key is TaskGroup ID.
Generated from protobuf field map<string, .google.cloud.batch.v1.JobStatus.TaskGroupStatus> task_groups = 4;
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\MapField | |
setTaskGroups
Aggregated task status for each TaskGroup in the Job.
The map key is TaskGroup ID.
Generated from protobuf field map<string, .google.cloud.batch.v1.JobStatus.TaskGroupStatus> task_groups = 4;
| Parameter | |
|---|---|
| Name | Description |
var |
array|Google\Protobuf\Internal\MapField
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getRunDuration
The duration of time that the Job spent in status RUNNING.
Generated from protobuf field .google.protobuf.Duration run_duration = 5;
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Duration|null | |
hasRunDuration
clearRunDuration
setRunDuration
The duration of time that the Job spent in status RUNNING.
Generated from protobuf field .google.protobuf.Duration run_duration = 5;
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Duration
|
| Returns | |
|---|---|
| Type | Description |
$this | |