Google Cloud Dataproc V1 Client - Class JobStatus (3.5.1)

Reference documentation and code samples for the Google Cloud Dataproc V1 Client class JobStatus.

Dataproc job status.

Generated from protobuf message google.cloud.dataproc.v1.JobStatus

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ state int

Output only. A state message specifying the overall job state.

↳ details string

Optional. Output only. Job state details, such as an error description if the state is ERROR.

↳ state_start_time Google\Protobuf\Timestamp

Output only. The time when this state was entered.

↳ substate int

Output only. Additional state information, which includes status reported by the agent.

getState

Output only. A state message specifying the overall job state.

Returns
TypeDescription
int

setState

Output only. A state message specifying the overall job state.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getDetails

Optional. Output only. Job state details, such as an error description if the state is ERROR.

Returns
TypeDescription
string

setDetails

Optional. Output only. Job state details, such as an error description if the state is ERROR.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getStateStartTime

Output only. The time when this state was entered.

Returns
TypeDescription
Google\Protobuf\Timestamp|null

hasStateStartTime

clearStateStartTime

setStateStartTime

Output only. The time when this state was entered.

Parameter
NameDescription
var Google\Protobuf\Timestamp
Returns
TypeDescription
$this

getSubstate

Output only. Additional state information, which includes status reported by the agent.

Returns
TypeDescription
int

setSubstate

Output only. Additional state information, which includes status reported by the agent.

Parameter
NameDescription
var int
Returns
TypeDescription
$this