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 | |
|---|---|
| Name | Description |
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 |
↳ 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.
Generated from protobuf field .google.cloud.dataproc.v1.JobStatus.State state = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
int | |
setState
Output only. A state message specifying the overall job state.
Generated from protobuf field .google.cloud.dataproc.v1.JobStatus.State state = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getDetails
Optional. Output only. Job state details, such as an error
description if the state is ERROR.
Generated from protobuf field string details = 2 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
string | |
setDetails
Optional. Output only. Job state details, such as an error
description if the state is ERROR.
Generated from protobuf field string details = 2 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getStateStartTime
Output only. The time when this state was entered.
Generated from protobuf field .google.protobuf.Timestamp state_start_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null | |
hasStateStartTime
clearStateStartTime
setStateStartTime
Output only. The time when this state was entered.
Generated from protobuf field .google.protobuf.Timestamp state_start_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getSubstate
Output only. Additional state information, which includes status reported by the agent.
Generated from protobuf field .google.cloud.dataproc.v1.JobStatus.Substate substate = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
int | |
setSubstate
Output only. Additional state information, which includes status reported by the agent.
Generated from protobuf field .google.cloud.dataproc.v1.JobStatus.Substate substate = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |