Reference documentation and code samples for the Google Cloud Dataproc V1 Client class ClusterStatus.
The status of a cluster and its instances.
Generated from protobuf message google.cloud.dataproc.v1.ClusterStatus
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ state |
int
Output only. The cluster's state. |
↳ detail |
string
Optional. Output only. Details of cluster's state. |
↳ state_start_time |
Google\Protobuf\Timestamp
Output only. Time when this state was entered (see JSON representation of Timestamp). |
↳ substate |
int
Output only. Additional state information that includes status reported by the agent. |
getState
Output only. The cluster's state.
Generated from protobuf field .google.cloud.dataproc.v1.ClusterStatus.State state = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
int | |
setState
Output only. The cluster's state.
Generated from protobuf field .google.cloud.dataproc.v1.ClusterStatus.State state = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getDetail
Optional. Output only. Details of cluster's state.
Generated from protobuf field string detail = 2 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
string | |
setDetail
Optional. Output only. Details of cluster's state.
Generated from protobuf field string detail = 2 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getStateStartTime
Output only. Time when this state was entered (see JSON representation of Timestamp).
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. Time when this state was entered (see JSON representation of Timestamp).
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 | |
getSubstate
Output only. Additional state information that includes status reported by the agent.
Generated from protobuf field .google.cloud.dataproc.v1.ClusterStatus.Substate substate = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
int | |
setSubstate
Output only. Additional state information that includes status reported by the agent.
Generated from protobuf field .google.cloud.dataproc.v1.ClusterStatus.Substate substate = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |