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

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

The request message for EntityTypes.DeleteEntityType.

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

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 entity type to delete. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/entityTypes/<Entity Type ID>.
↳ force bool

This field has no effect for entity type not being used. For entity types that are used by intents or pages: * If force is set to false, an error will be returned with message indicating the referencing resources. * If force is set to true, Dialogflow will remove the entity type, as well as any references to the entity type (i.e. Page parameter of the entity type will be changed to '@sys.any' and intent parameter of the entity type will be removed).

getName

Required. The name of the entity type to delete.

Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/entityTypes/<Entity Type ID>.

Returns
Type Description
string

setName

Required. The name of the entity type to delete.

Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/entityTypes/<Entity Type ID>.

Parameter
Name Description
var string
Returns
Type Description
$this

getForce

This field has no effect for entity type not being used.

For entity types that are used by intents or pages:

  • If force is set to false, an error will be returned with message indicating the referencing resources.
  • If force is set to true, Dialogflow will remove the entity type, as well as any references to the entity type (i.e. Page parameter of the entity type will be changed to '@sys.any' and intent parameter of the entity type will be removed).
Returns
Type Description
bool

setForce

This field has no effect for entity type not being used.

For entity types that are used by intents or pages:

  • If force is set to false, an error will be returned with message indicating the referencing resources.
  • If force is set to true, Dialogflow will remove the entity type, as well as any references to the entity type (i.e. Page parameter of the entity type will be changed to '@sys.any' and intent parameter of the entity type will be removed).
Parameter
Name Description
var bool
Returns
Type Description
$this

static::build

Parameter
Name Description
name string

Required. The name of the entity type to delete. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/entityTypes/<Entity Type ID>. Please see Google\Cloud\Dialogflow\Cx\V3\EntityTypesClient::entityTypeName() for help formatting this field.
Returns
Type Description
Google\Cloud\Dialogflow\Cx\V3\DeleteEntityTypeRequest