# Google Cloud Config V1 Client - Class DeprovisionDeploymentGroupRequest (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 DeprovisionDeploymentGroupRequest.

The request message for the DeprovisionDeploymentGroup method.

Generated from protobuf message `google.cloud.config.v1.DeprovisionDeploymentGroupRequest`

## Namespace

Google \\ Cloud \\ Config \\ V1

## Methods

### __construct

Constructor.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `data` | `array` Optional. Data for populating the Message object. |
| `↳ name` | `string` Required. The name of the deployment group to deprovision. Format: 'projects/{project_id}/locations/{location}/deploymentGroups/{deployment_group}'. |
| `↳ force` | `bool` Optional. If set to true, this option is propagated to the deletion of each deployment in the group. This corresponds to the 'force' field in DeleteDeploymentRequest. |
| `↳ delete_policy` | `int` Optional. Policy on how resources within each deployment should be handled during deletion. This policy is applied globally to the deletion of all deployments in this group. This corresponds to the 'delete_policy' field in DeleteDeploymentRequest. |

### getName

Required. The name of the deployment group to deprovision.

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

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` |   |

### setName

Required. The name of the deployment group to deprovision.

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

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `string` |

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

### getForce

Optional. If set to true, this option is propagated to the deletion of each
deployment in the group. This corresponds to the 'force' field
in DeleteDeploymentRequest.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `bool` |   |

### setForce

Optional. If set to true, this option is propagated to the deletion of each
deployment in the group. This corresponds to the 'force' field
in DeleteDeploymentRequest.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `bool` |

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

### getDeletePolicy

Optional. Policy on how resources within each deployment should be handled
during deletion. This policy is applied globally to the deletion of all
deployments in this group. This corresponds to the 'delete_policy' field
in DeleteDeploymentRequest.

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

### setDeletePolicy

Optional. Policy on how resources within each deployment should be handled
during deletion. This policy is applied globally to the deletion of all
deployments in this group. This corresponds to the 'delete_policy' field
in DeleteDeploymentRequest.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `int` Enum of type [DeletePolicy](https://docs.cloud.google.com/php/docs/reference/cloud-config/latest/V1.DeleteDeploymentRequest.DeletePolicy). |

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

### static::build

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `name` | `string` Required. The name of the deployment group to deprovision. Format: 'projects/{project_id}/locations/{location}/deploymentGroups/{deployment_group}'. Please see ConfigClient::deploymentGroupName() for help formatting this field. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/cloud-config/latest/V1.DeprovisionDeploymentGroupRequest` |   |