Google Cloud Dialogflow Cx V3 Client - Class DeleteWebhookRequest (0.4.0)

Reference documentation and code samples for the Google Cloud Dialogflow Cx V3 Client class DeleteWebhookRequest.

The request message for Webhooks.DeleteWebhook.

Generated from protobuf message google.cloud.dialogflow.cx.v3.DeleteWebhookRequest

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 webhook to delete. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/webhooks/<Webhook ID>.
↳ force bool

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).

getName

Required. The name of the webhook to delete.

Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/webhooks/<Webhook ID>.

Returns
Type Description
string

setName

Required. The name of the webhook to delete.

Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/webhooks/<Webhook ID>.

Parameter
Name Description
var string
Returns
Type Description
$this

getForce

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
Type Description
bool

setForce

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).
Parameter
Name Description
var bool
Returns
Type Description
$this

static::build

Parameter
Name Description
name string

Required. The name of the webhook to delete. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/webhooks/<Webhook ID>. Please see Google\Cloud\Dialogflow\Cx\V3\WebhooksClient::webhookName() for help formatting this field.
Returns
Type Description
Google\Cloud\Dialogflow\Cx\V3\DeleteWebhookRequest