Dialogflow CX V3 API - Class Google::Cloud::Dialogflow::CX::V3::DeleteWebhookRequest (v0.15.1)

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

The request message for Webhooks.DeleteWebhook.

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 webhook not being used. For webhooks that are used by pages/flows/transition route groups:

    • If force is set to false, an error will be returned with message indicating the referenced resources.
    • If force is set to true, Dialogflow will remove the webhook, as well as any references to the webhook (i.e. Webhook and tagin fulfillments that point to this webhook will be removed).

#force=

def force=(value) -> ::Boolean
Parameter
  • value (::Boolean) —

    This field has no effect for webhook not being used. For webhooks that are used by pages/flows/transition route groups:

    • If force is set to false, an error will be returned with message indicating the referenced resources.
    • If force is set to true, Dialogflow will remove the webhook, as well as any references to the webhook (i.e. Webhook and tagin fulfillments that point to this webhook will be removed).
Returns
  • (::Boolean) —

    This field has no effect for webhook not being used. For webhooks that are used by pages/flows/transition route groups:

    • If force is set to false, an error will be returned with message indicating the referenced resources.
    • If force is set to true, Dialogflow will remove the webhook, as well as any references to the webhook (i.e. Webhook and tagin fulfillments that point to this webhook will be removed).

#name

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

#name=

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