Class: Google::Cloud::Dialogflow::CX::V3::DeleteFlowRequest

Inherits:

Object

Object
Google::Cloud::Dialogflow::CX::V3::DeleteFlowRequest

show all

Extended by:: Protobuf::MessageExts::ClassMethods

Includes:: Protobuf::MessageExts

Defined in:: proto_docs/google/cloud/dialogflow/cx/v3/flow.rb

Overview

The request message for Flows.DeleteFlow.

Instance Attribute Summary collapse

#force ⇒ ::Boolean
This field has no effect for flows with no incoming transitions.
#name ⇒ ::String
Required.

Instance Attribute Details

#force ⇒ `::Boolean`

Returns 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][EventHandler.target_flow] in event handlers or [Target flow][TransitionRoute.target_flow] in transition routes that point to this flow will be cleared).

Returns:

(::Boolean) —
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][EventHandler.target_flow] in event handlers or [Target flow][TransitionRoute.target_flow] in transition routes that point to this flow will be cleared).

# File 'proto_docs/google/cloud/dialogflow/cx/v3/flow.rb', line 236

class DeleteFlowRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#name ⇒ `::String`

Returns Required. The name of the flow to delete. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>.