Google Cloud Batch V1 Client - Class JobStatus (0.2.2)

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
NameDescription
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
TypeDescription
int

setState

Job state

Generated from protobuf field .google.cloud.batch.v1.JobStatus.State state = 1;

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getStatusEvents

Job status events

Generated from protobuf field repeated .google.cloud.batch.v1.StatusEvent status_events = 2;

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setStatusEvents

Job status events

Generated from protobuf field repeated .google.cloud.batch.v1.StatusEvent status_events = 2;

Parameter
NameDescription
var array<Google\Cloud\Batch\V1\StatusEvent>
Returns
TypeDescription
$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
TypeDescription
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
NameDescription
var array|Google\Protobuf\Internal\MapField
Returns
TypeDescription
$this

getRunDuration

The duration of time that the Job spent in status RUNNING.

Generated from protobuf field .google.protobuf.Duration run_duration = 5;

Returns
TypeDescription
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
NameDescription
var Google\Protobuf\Duration
Returns
TypeDescription
$this