Google Cloud Dataproc V1 Client - Class StateHistory (3.2.2)

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

Historical state information.

Generated from protobuf message google.cloud.dataproc.v1.Batch.StateHistory

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ state int

Output only. The state of the batch at this point in history.

↳ state_message string

Output only. Details about the state at this point in history.

↳ state_start_time Google\Protobuf\Timestamp

Output only. The time when the batch entered the historical state.

getState

Output only. The state of the batch at this point in history.

Generated from protobuf field .google.cloud.dataproc.v1.Batch.State state = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

setState

Output only. The state of the batch at this point in history.

Generated from protobuf field .google.cloud.dataproc.v1.Batch.State state = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
var int
Returns
Type Description
$this

getStateMessage

Output only. Details about the state at this point in history.

Generated from protobuf field string state_message = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
string

setStateMessage

Output only. Details about the state at this point in history.

Generated from protobuf field string state_message = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
var string
Returns
Type Description
$this

getStateStartTime

Output only. The time when the batch entered the historical state.

Generated from protobuf field .google.protobuf.Timestamp state_start_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Google\Protobuf\Timestamp|null

hasStateStartTime

clearStateStartTime

setStateStartTime

Output only. The time when the batch entered the historical state.

Generated from protobuf field .google.protobuf.Timestamp state_start_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

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