# Google Cloud Dialogflow Cx V3 Client - Class DeleteFlowRequest (0.11.1)

0.11.1 (latest) 0.11.0 0.10.2 0.9.2 0.8.1 0.7.2 0.6.0 0.5.2 0.4.1 0.3.4 0.2.1 0.1.1 Reference documentation and code samples for the Google Cloud Dialogflow Cx V3 Client class DeleteFlowRequest.

The request message for
[Flows.DeleteFlow](https://docs.cloud.google.com/php/docs/reference/cloud-dialogflow-cx/latest/V3.Client.FlowsClient#_Google_Cloud_Dialogflow_Cx_V3_Client_FlowsClient__deleteFlow__).

Generated from protobuf message `google.cloud.dialogflow.cx.v3.DeleteFlowRequest`

## Namespace

Google \\ Cloud \\ Dialogflow \\ Cx \\ V3

## Methods

### __construct

Constructor.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `data` | `array` Optional. Data for populating the Message object. |
| `↳ name` | `string` Required. The name of the flow to delete. Format: `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>`. |
| `↳ force` | `bool` This field has no effect for flows with no incoming transitions. For flows with incoming transitions: \* \* If `force` is set to false, an error will be returned with message indicating the incoming transitions. \* \* If `force` is set to true, Dialogflow will remove the flow, as well as any transitions to the flow (i.e. Target flow in event handlers or Target flow in transition routes that point to this flow will be cleared). |

### getName

Required. The name of the flow to delete.

Format:
`projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>`.

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

### setName

Required. The name of the flow to delete.

Format:
`projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>`.

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

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

### getForce

This field has no effect for flows with no incoming transitions.

For flows with incoming transitions:

- If `force` is set to false, an error will be returned with message indicating the incoming transitions.
- If `force` is set to true, Dialogflow will remove the flow, as well as any transitions to the flow (i.e. Target flow in event handlers or Target flow in transition routes that point to this flow will be cleared).

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

### setForce

This field has no effect for flows with no incoming transitions.

For flows with incoming transitions:

- If `force` is set to false, an error will be returned with message indicating the incoming transitions.
- If `force` is set to true, Dialogflow will remove the flow, as well as any transitions to the flow (i.e. Target flow in event handlers or Target flow in transition routes that point to this flow will be cleared).

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

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

### static::build

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `name` | `string` Required. The name of the flow to delete. Format: `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>`. Please see FlowsClient::flowName() for help formatting this field. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/cloud-dialogflow-cx/latest/V3.DeleteFlowRequest` |   |