Dialogflow CX V3 API - Class Google::Cloud::Dialogflow::CX::V3::DeleteFlowRequest (v0.17.0)

Reference documentation and code samples for the Dialogflow CX V3 API class Google::Cloud::Dialogflow::CX::V3::DeleteFlowRequest.

The request message for Flows.DeleteFlow.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#force

def force() -> ::Boolean
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).

#force=

def force=(value) -> ::Boolean
Parameter
  • value (::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).
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).

#name

def name() -> ::String
Returns
  • (::String) — Required. The name of the flow to delete. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>.

#name=

def name=(value) -> ::String
Parameter
  • value (::String) — Required. The name of the flow to delete. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>.
Returns
  • (::String) — Required. The name of the flow to delete. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>.