Google Cloud Dialogflow Cx V3 Client - Class ExportEntityTypesRequest (0.5.1)

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

The request message for EntityTypes.ExportEntityTypes.

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

Namespace

Google \ Cloud \ Dialogflow \ Cx \ V3

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ parent string

Required. The name of the parent agent to export entity types. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>.

↳ entity_types array

Required. The name of the entity types to export. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/entityTypes/<EntityTypeID>.

↳ entity_types_uri string

Optional. The Google Cloud Storage URI to export the entity types to. The format of this URI must be gs://<bucket-name>/<object-name>. Dialogflow performs a write operation for the Cloud Storage object on the caller's behalf, so your request authentication must have write permissions for the object. For more information, see Dialogflow access control.

↳ entity_types_content_inline bool

Optional. The option to return the serialized entity types inline.

↳ data_format int

Optional. The data format of the exported entity types. If not specified, BLOB is assumed.

↳ language_code string

Optional. The language to retrieve the entity type for. The following fields are language dependent: * * EntityType.entities.value * * EntityType.entities.synonyms * * EntityType.excluded_phrases.value If not specified, all language dependent fields will be retrieved. Many languages are supported. Note: languages must be enabled in the agent before they can be used.

getParent

Required. The name of the parent agent to export entity types.

Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>.

Returns
Type Description
string

setParent

Required. The name of the parent agent to export entity types.

Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>.

Parameter
Name Description
var string
Returns
Type Description
$this

getEntityTypes

Required. The name of the entity types to export.

Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/entityTypes/<EntityTypeID>.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setEntityTypes

Required. The name of the entity types to export.

Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/entityTypes/<EntityTypeID>.

Parameter
Name Description
var string[]
Returns
Type Description
$this

getEntityTypesUri

Optional. The Google Cloud Storage URI to export the entity types to. The format of this URI must be gs://<bucket-name>/<object-name>.

Dialogflow performs a write operation for the Cloud Storage object on the caller's behalf, so your request authentication must have write permissions for the object. For more information, see Dialogflow access control.

Returns
Type Description
string

hasEntityTypesUri

setEntityTypesUri

Optional. The Google Cloud Storage URI to export the entity types to. The format of this URI must be gs://<bucket-name>/<object-name>.

Dialogflow performs a write operation for the Cloud Storage object on the caller's behalf, so your request authentication must have write permissions for the object. For more information, see Dialogflow access control.

Parameter
Name Description
var string
Returns
Type Description
$this

getEntityTypesContentInline

Optional. The option to return the serialized entity types inline.

Returns
Type Description
bool

hasEntityTypesContentInline

setEntityTypesContentInline

Optional. The option to return the serialized entity types inline.

Parameter
Name Description
var bool
Returns
Type Description
$this

getDataFormat

Optional. The data format of the exported entity types. If not specified, BLOB is assumed.

Returns
Type Description
int

setDataFormat

Optional. The data format of the exported entity types. If not specified, BLOB is assumed.

Parameter
Name Description
var int
Returns
Type Description
$this

getLanguageCode

Optional. The language to retrieve the entity type for. The following fields are language dependent:

  • EntityType.entities.value
  • EntityType.entities.synonyms
  • EntityType.excluded_phrases.value If not specified, all language dependent fields will be retrieved.

Many languages are supported. Note: languages must be enabled in the agent before they can be used.

Returns
Type Description
string

setLanguageCode

Optional. The language to retrieve the entity type for. The following fields are language dependent:

  • EntityType.entities.value
  • EntityType.entities.synonyms
  • EntityType.excluded_phrases.value If not specified, all language dependent fields will be retrieved.

Many languages are supported. Note: languages must be enabled in the agent before they can be used.

Parameter
Name Description
var string
Returns
Type Description
$this

getDestination

Returns
Type Description
string