Dialogflow CX V3 API - Class Google::Cloud::Dialogflow::CX::V3::DeleteEntityTypeRequest (v0.11.0)

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

The request message for EntityTypes.DeleteEntityType.

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

#force=

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

    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
  • (::Boolean) —

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

#name

def name() -> ::String
Returns
  • (::String) — Required. The name of the entity type to delete. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/entityTypes/<Entity Type ID>.

#name=

def name=(value) -> ::String
Parameter
  • value (::String) — Required. The name of the entity type to delete. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/entityTypes/<Entity Type ID>.
Returns
  • (::String) — Required. The name of the entity type to delete. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/entityTypes/<Entity Type ID>.