Google Cloud Dialogflow Cx V3 Client - Class DeletePageRequest (0.3.4)

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

The request message for Pages.DeletePage.

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

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 page to delete. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/Flows/<flow ID>/pages/<Page ID>.
↳ force bool

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 in event handlers or Target page in transition routes that point to this page will be cleared).

getName

Required. The name of the page to delete.

Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/Flows/<flow ID>/pages/<Page ID>.

Returns
Type Description
string

setName

Required. The name of the page to delete.

Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/Flows/<flow ID>/pages/<Page ID>.

Parameter
Name Description
var string
Returns
Type Description
$this

getForce

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 in event handlers or Target page in transition routes that point to this page will be cleared).
Returns
Type Description
bool

setForce

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 in event handlers or Target page in transition routes that point to this page will be cleared).
Parameter
Name Description
var bool
Returns
Type Description
$this

static::build

Parameter
Name Description
name string

Required. The name of the page to delete. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/Flows/<flow ID>/pages/<Page ID>. Please see Google\Cloud\Dialogflow\Cx\V3\PagesClient::pageName() for help formatting this field.
Returns
Type Description
Google\Cloud\Dialogflow\Cx\V3\DeletePageRequest