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

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

The request message for Generators.DeleteGenerator.

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

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

This field has no effect for generators not being used. For generators 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 generator, as well as any references to the generator (i.e. Generator) in fulfillments.

getName

Required. The name of the generator to delete.

Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/generators/<Generator ID>.

Returns
Type Description
string

setName

Required. The name of the generator to delete.

Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/generators/<Generator ID>.

Parameter
Name Description
var string
Returns
Type Description
$this

getForce

This field has no effect for generators not being used.

For generators 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 generator, as well as any references to the generator (i.e. Generator) in fulfillments.
Returns
Type Description
bool

setForce

This field has no effect for generators not being used.

For generators 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 generator, as well as any references to the generator (i.e. Generator) in fulfillments.
Parameter
Name Description
var bool
Returns
Type Description
$this

static::build

Parameter
Name Description
name string

Required. The name of the generator to delete. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/generators/<Generator ID>. Please see Google\Cloud\Dialogflow\Cx\V3\GeneratorsClient::generatorName() for help formatting this field.
Returns
Type Description
Google\Cloud\Dialogflow\Cx\V3\DeleteGeneratorRequest