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

Request message for Delete DeploymentGroup

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

## 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 DeploymentGroup in the format projects/{project_id}/locations/{location_id}/deploymentGroups/{deploymentGroup} |
| `↳ request_id` | `string` Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). |
| `↳ force` | `bool` Optional. If set to true, any revisions for this deployment group will also be deleted. (Otherwise, the request will only work if the deployment group has no revisions.) |
| `↳ deployment_reference_policy` | `int` Optional. Policy on how to handle referenced deployments when deleting the DeploymentGroup. If unspecified, the default behavior is to fail the deletion if any deployments currently referenced in the `deployment_units` of the DeploymentGroup or in the latest revision are not deleted. |

### getName

Required. The name of DeploymentGroup in the format
projects/{project_id}/locations/{location_id}/deploymentGroups/{deploymentGroup}

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

### setName

Required. The name of DeploymentGroup in the format
projects/{project_id}/locations/{location_id}/deploymentGroups/{deploymentGroup}

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

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

### getRequestId

Optional. An optional request ID to identify requests. Specify a unique
request ID so that if you must retry your request, the server will know to
ignore the request if it has already been completed. The server will
guarantee that for at least 60 minutes after the first request.

For example, consider a situation where you make an initial request and the
request times out. If you make the request again with the same request ID,
the server can check if original operation with the same request ID was
received, and if so, will ignore the second request. This prevents clients
from accidentally creating duplicate commitments.
The request ID must be a valid UUID with the exception that zero UUID is
not supported (00000000-0000-0000-0000-000000000000).

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

### setRequestId

Optional. An optional request ID to identify requests. Specify a unique
request ID so that if you must retry your request, the server will know to
ignore the request if it has already been completed. The server will
guarantee that for at least 60 minutes after the first request.

For example, consider a situation where you make an initial request and the
request times out. If you make the request again with the same request ID,
the server can check if original operation with the same request ID was
received, and if so, will ignore the second request. This prevents clients
from accidentally creating duplicate commitments.
The request ID must be a valid UUID with the exception that zero UUID is
not supported (00000000-0000-0000-0000-000000000000).

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

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

### getForce

Optional. If set to true, any revisions for this deployment group will also
be deleted. (Otherwise, the request will only work if the deployment group
has no revisions.)

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

### setForce

Optional. If set to true, any revisions for this deployment group will also
be deleted. (Otherwise, the request will only work if the deployment group
has no revisions.)

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

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

### getDeploymentReferencePolicy

Optional. Policy on how to handle referenced deployments when deleting the
DeploymentGroup.

If unspecified, the default behavior is to fail the deletion if any
deployments currently referenced in the `deployment_units` of the
DeploymentGroup or in the latest revision are not deleted.

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

### setDeploymentReferencePolicy

Optional. Policy on how to handle referenced deployments when deleting the
DeploymentGroup.

If unspecified, the default behavior is to fail the deletion if any
deployments currently referenced in the `deployment_units` of the
DeploymentGroup or in the latest revision are not deleted.

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

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

### static::build

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `name` | `string` Required. The name of DeploymentGroup in the format projects/{project_id}/locations/{location_id}/deploymentGroups/{deploymentGroup} Please see ConfigClient::deploymentGroupName() for help formatting this field. |

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