Class: Google::Cloud::Dialogflow::CX::V3::DeletePageRequest

Inherits:

Object

Object
Google::Cloud::Dialogflow::CX::V3::DeletePageRequest

show all

Extended by:: Protobuf::MessageExts::ClassMethods

Includes:: Protobuf::MessageExts

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

Overview

The request message for Pages.DeletePage.

Instance Attribute Summary collapse

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

Instance Attribute Details

#force ⇒ `::Boolean`

Returns This field has no effect for pages with no incoming transitions. For pages 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 page, as well as any transitions to the page (i.e. [Target page][EventHandler.target_page] in event handlers or [Target page][TransitionRoute.target_page] in transition routes that point to this page will be cleared).

Returns:

(::Boolean) —
This field has no effect for pages with no incoming transitions. For pages 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 page, as well as any transitions to the page (i.e. [Target page][EventHandler.target_page] in event handlers or [Target page][TransitionRoute.target_page] in transition routes that point to this page will be cleared).

# File 'proto_docs/google/cloud/dialogflow/cx/v3/page.rb', line 518

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

#name ⇒ `::String`

Returns Required. The name of the page to delete. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/Flows/<flowID>/pages/<PageID>.