Google Cloud Network Connectivity V1 Client - Class StateMetadata (2.5.1)

Reference documentation and code samples for the Google Cloud Network Connectivity V1 Client class StateMetadata.

The state and activation time details of the resource state.

Generated from protobuf message google.cloud.networkconnectivity.v1.StateTimeline.StateMetadata

Namespace

Google \ Cloud \ NetworkConnectivity \ V1 \ StateTimeline

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ state int

Output only. The state of the resource.
↳ effective_time Google\Protobuf\Timestamp

Output only. Accompanies only the transient states, which include ADDING, DELETING, and SUSPENDING, to denote the time until which the transient state of the resource will be effective. For instance, if the state is ADDING, this field shows the time when the resource state transitions to ACTIVE.

getState

Output only. The state of the resource.

Returns
Type Description
int Enum of type State.

setState

Output only. The state of the resource.

Parameter
Name Description
var int

Enum of type State.

Returns
Type Description
$this

getEffectiveTime

Output only. Accompanies only the transient states, which include ADDING, DELETING, and SUSPENDING, to denote the time until which the transient state of the resource will be effective. For instance, if the state is ADDING, this field shows the time when the resource state transitions to ACTIVE.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasEffectiveTime

clearEffectiveTime

setEffectiveTime

Output only. Accompanies only the transient states, which include ADDING, DELETING, and SUSPENDING, to denote the time until which the transient state of the resource will be effective. For instance, if the state is ADDING, this field shows the time when the resource state transitions to ACTIVE.

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