Google Cloud Config V1 Client - Class DeploymentGroup (1.8.0)

Reference documentation and code samples for the Google Cloud Config V1 Client class DeploymentGroup.

A DeploymentGroup is a collection of DeploymentUnits that in a DAG-like structure.

Generated from protobuf message google.cloud.config.v1.DeploymentGroup

Namespace

Google \ Cloud \ Config \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ name string

Identifier. The name of the deployment group. Format: 'projects/{project_id}/locations/{location}/deploymentGroups/{deployment_group}'.
↳ create_time Google\Protobuf\Timestamp

Output only. Time when the deployment group was created.
↳ update_time Google\Protobuf\Timestamp

Output only. Time when the deployment group was last updated.
↳ labels array|Google\Protobuf\Internal\MapField

Optional. User-defined metadata for the deployment group.
↳ annotations array|Google\Protobuf\Internal\MapField

Optional. Arbitrary key-value metadata storage e.g. to help client tools identify deployment group during automation. See https://google.aip.dev/148#annotations for details on format and size limitations.
↳ state int

Output only. Current state of the deployment group.
↳ state_description string

Output only. Additional information regarding the current state.
↳ deployment_units array<DeploymentUnit>

The deployment units of the deployment group in a DAG like structure. When a deployment group is being provisioned, the deployment units are deployed in a DAG order. The provided units must be in a DAG order, otherwise an error will be returned.
↳ provisioning_state int

Output only. The provisioning state of the deployment group.
↳ provisioning_state_description string

Output only. Additional information regarding the current provisioning state.
↳ provisioning_error Google\Rpc\Status

Output only. The error status of the deployment group provisioning or deprovisioning.

getName

Identifier. The name of the deployment group.

Format: 'projects/{project_id}/locations/{location}/deploymentGroups/{deployment_group}'.

Returns
Type Description
string

setName

Identifier. The name of the deployment group.

Format: 'projects/{project_id}/locations/{location}/deploymentGroups/{deployment_group}'.

Parameter
Name Description
var string
Returns
Type Description
$this

getCreateTime

Output only. Time when the deployment group was created.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasCreateTime

clearCreateTime

setCreateTime

Output only. Time when the deployment group was created.

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

getUpdateTime

Output only. Time when the deployment group was last updated.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasUpdateTime

clearUpdateTime

setUpdateTime

Output only. Time when the deployment group was last updated.

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

getLabels

Optional. User-defined metadata for the deployment group.

Returns
Type Description
Google\Protobuf\Internal\MapField

setLabels

Optional. User-defined metadata for the deployment group.

Parameter
Name Description
var array|Google\Protobuf\Internal\MapField
Returns
Type Description
$this

getAnnotations

Optional. Arbitrary key-value metadata storage e.g. to help client tools identify deployment group during automation. See https://google.aip.dev/148#annotations for details on format and size limitations.

Returns
Type Description
Google\Protobuf\Internal\MapField

setAnnotations

Optional. Arbitrary key-value metadata storage e.g. to help client tools identify deployment group during automation. See https://google.aip.dev/148#annotations for details on format and size limitations.

Parameter
Name Description
var array|Google\Protobuf\Internal\MapField
Returns
Type Description
$this

getState

Output only. Current state of the deployment group.

Returns
Type Description
int Enum of type State.

setState

Output only. Current state of the deployment group.

Parameter
Name Description
var int

Enum of type State.

Returns
Type Description
$this

getStateDescription

Output only. Additional information regarding the current state.

Returns
Type Description
string

setStateDescription

Output only. Additional information regarding the current state.

Parameter
Name Description
var string
Returns
Type Description
$this

getDeploymentUnits

The deployment units of the deployment group in a DAG like structure.

When a deployment group is being provisioned, the deployment units are deployed in a DAG order. The provided units must be in a DAG order, otherwise an error will be returned.

Returns
Type Description
Google\Protobuf\RepeatedField<DeploymentUnit>

setDeploymentUnits

The deployment units of the deployment group in a DAG like structure.

When a deployment group is being provisioned, the deployment units are deployed in a DAG order. The provided units must be in a DAG order, otherwise an error will be returned.

Parameter
Name Description
var array<DeploymentUnit>
Returns
Type Description
$this

getProvisioningState

Output only. The provisioning state of the deployment group.

Returns
Type Description
int Enum of type ProvisioningState.

setProvisioningState

Output only. The provisioning state of the deployment group.

Parameter
Name Description
var int

Enum of type ProvisioningState.

Returns
Type Description
$this

getProvisioningStateDescription

Output only. Additional information regarding the current provisioning state.

Returns
Type Description
string

setProvisioningStateDescription

Output only. Additional information regarding the current provisioning state.

Parameter
Name Description
var string
Returns
Type Description
$this

getProvisioningError

Output only. The error status of the deployment group provisioning or deprovisioning.

Returns
Type Description
Google\Rpc\Status|null

hasProvisioningError

clearProvisioningError

setProvisioningError

Output only. The error status of the deployment group provisioning or deprovisioning.

Parameter
Name Description
var Google\Rpc\Status
Returns
Type Description
$this