Google Cloud Batch V1 Client - Class JobStatus (0.17.0)

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

Namespace

Google \ Cloud \ Batch \ V1

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

Returns
Type Description
int

setState

Job state

Parameter
Name Description
var int
Returns
Type Description
$this

getStatusEvents

Job status events

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setStatusEvents

Job status events

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.

Returns
Type Description
Google\Protobuf\Internal\MapField

setTaskGroups

Aggregated task status for each TaskGroup in the Job.

The map key is TaskGroup ID.

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.

Returns
Type Description
Google\Protobuf\Duration|null

hasRunDuration

clearRunDuration

setRunDuration

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

Parameter
Name Description
var Google\Protobuf\Duration
Returns
Type Description
$this