Reference documentation and code samples for the Compute V1 Client class ResourceStatusShutdownDetails.
Specifies if the instance is in PENDING_STOP state or there is a
programmed stop scheduled.
Generated from protobuf message google.cloud.compute.v1.ResourceStatusShutdownDetails
Namespace
Google \ Cloud \ Compute \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ max_duration |
Duration
The duration for graceful shutdown. Only applicable when |
↳ request_timestamp |
string
Past timestamp indicating the beginning of current |
↳ stop_state |
string
Current stopping state of the instance. Check the StopState enum for the list of possible values. |
↳ target_state |
string
Target instance state. Check the TargetState enum for the list of possible values. |
getMaxDuration
The duration for graceful shutdown. Only applicable when
stop_state=PENDING_STOP.
| Returns | |
|---|---|
| Type | Description |
Duration|null |
|
hasMaxDuration
clearMaxDuration
setMaxDuration
The duration for graceful shutdown. Only applicable when
stop_state=PENDING_STOP.
| Parameter | |
|---|---|
| Name | Description |
var |
Duration
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getRequestTimestamp
Past timestamp indicating the beginning of current stopState in RFC3339 text format.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasRequestTimestamp
clearRequestTimestamp
setRequestTimestamp
Past timestamp indicating the beginning of current stopState in RFC3339 text format.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getStopState
Current stopping state of the instance.
Check the StopState enum for the list of possible values.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasStopState
clearStopState
setStopState
Current stopping state of the instance.
Check the StopState enum for the list of possible values.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getTargetState
Target instance state.
Check the TargetState enum for the list of possible values.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasTargetState
clearTargetState
setTargetState
Target instance state.
Check the TargetState enum for the list of possible values.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|