# Google Cloud Config V1 Client - Class DeploymentGroup (1.8.0)

1.8.0 (latest) 1.7.2 1.6.1 1.5.0 1.4.1 1.3.0 1.2.1 1.1.0 1.0.1 0.5.2 0.2.0 0.1.3 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` | `https://protobuf.dev/reference/php/api-docs/Google/Protobuf/Timestamp` Output only. Time when the deployment group was created. |
| `↳ update_time` | `https://protobuf.dev/reference/php/api-docs/Google/Protobuf/Timestamp` Output only. Time when the deployment group was last updated. |
| `↳ labels` | `array|https://protobuf.dev/reference/php/api-docs/Google/Protobuf/Internal/MapField` Optional. User-defined metadata for the deployment group. |
| `↳ annotations` | `array|https://protobuf.dev/reference/php/api-docs/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<https://docs.cloud.google.com/php/docs/reference/cloud-config/latest/V1.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` | `https://docs.cloud.google.com/php/docs/reference/common-protos/latest/Rpc.Status.html` 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** |
| `https://protobuf.dev/reference/php/api-docs/Google/Protobuf/Timestamp|null` |   |

### hasCreateTime

### clearCreateTime

### setCreateTime

Output only. Time when the deployment group was created.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `https://protobuf.dev/reference/php/api-docs/Google/Protobuf/Timestamp` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getUpdateTime

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

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://protobuf.dev/reference/php/api-docs/Google/Protobuf/Timestamp|null` |   |

### hasUpdateTime

### clearUpdateTime

### setUpdateTime

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

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `https://protobuf.dev/reference/php/api-docs/Google/Protobuf/Timestamp` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getLabels

Optional. User-defined metadata for the deployment group.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://protobuf.dev/reference/php/api-docs/Google/Protobuf/Internal/MapField` |   |

### setLabels

Optional. User-defined metadata for the deployment group.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `array|https://protobuf.dev/reference/php/api-docs/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** |
| `https://protobuf.dev/reference/php/api-docs/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|https://protobuf.dev/reference/php/api-docs/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](https://docs.cloud.google.com/php/docs/reference/cloud-config/latest/V1.DeploymentGroup.State). |

### setState

Output only. Current state of the deployment group.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `int` Enum of type [State](https://docs.cloud.google.com/php/docs/reference/cloud-config/latest/V1.DeploymentGroup.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** |
| `https://protobuf.dev/reference/php/api-docs/Google/Protobuf/RepeatedField<https://docs.cloud.google.com/php/docs/reference/cloud-config/latest/V1.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<https://docs.cloud.google.com/php/docs/reference/cloud-config/latest/V1.DeploymentUnit>` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getProvisioningState

Output only. The provisioning state of the deployment group.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `int` | Enum of type [ProvisioningState](https://docs.cloud.google.com/php/docs/reference/cloud-config/latest/V1.DeploymentGroup.ProvisioningState). |

### setProvisioningState

Output only. The provisioning state of the deployment group.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `int` Enum of type [ProvisioningState](https://docs.cloud.google.com/php/docs/reference/cloud-config/latest/V1.DeploymentGroup.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** |
| `https://docs.cloud.google.com/php/docs/reference/common-protos/latest/Rpc.Status.html|null` |   |

### hasProvisioningError

### clearProvisioningError

### setProvisioningError

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

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `https://docs.cloud.google.com/php/docs/reference/common-protos/latest/Rpc.Status.html` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |