Google Cloud Dialogflow Cx V3 Client - Class ExportAgentRequest (0.1.1)

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

The request message for Agents.ExportAgent.

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

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 agent to export. Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>`.
`↳ agent_uri`	`string` Optional. The Google Cloud Storage URI to export the agent to. The format of this URI must be `gs://<bucket-name>/<object-name>`. If left unspecified, the serialized agent is returned inline. 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.
`↳ data_format`	`int` Optional. The data format of the exported agent. If not specified, `BLOB` is assumed.
`↳ environment`	`string` Optional. Environment name. If not set, draft environment is assumed. Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment ID>`.
`↳ git_destination`	`Google\Cloud\Dialogflow\Cx\V3\ExportAgentRequest\GitDestination` Optional. The Git branch to export the agent to.
`↳ include_bigquery_export_settings`	`bool` Optional. Whether to include BigQuery Export setting.

getName

Required. The name of the agent to export.

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

Returns
Type	Description
`string`

setName

Required. The name of the agent to export.

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

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getAgentUri

Optional. The Google Cloud Storage URI to export the agent to. The format of this URI must be gs://<bucket-name>/<object-name>. If left unspecified, the serialized agent is returned inline.

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`

setAgentUri

Optional. The Google Cloud Storage URI to export the agent to. The format of this URI must be gs://<bucket-name>/<object-name>. If left unspecified, the serialized agent is returned inline.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getDataFormat

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

Returns
Type	Description
`int`

setDataFormat

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

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`

getEnvironment

Optional. Environment name. If not set, draft environment is assumed.

Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment ID>.

Returns
Type	Description
`string`

setEnvironment

Optional. Environment name. If not set, draft environment is assumed.

Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment ID>.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getGitDestination

Optional. The Git branch to export the agent to.

Returns
Type	Description
`Google\Cloud\Dialogflow\Cx\V3\ExportAgentRequest\GitDestination\|null`

hasGitDestination

clearGitDestination

setGitDestination

Optional. The Git branch to export the agent to.

Parameter
Name	Description
`var`	`Google\Cloud\Dialogflow\Cx\V3\ExportAgentRequest\GitDestination`

Returns
Type	Description
`$this`

getIncludeBigqueryExportSettings

Optional. Whether to include BigQuery Export setting.

Returns
Type	Description
`bool`

setIncludeBigqueryExportSettings

Optional. Whether to include BigQuery Export setting.

Parameter
Name	Description
`var`	`bool`

Returns
Type	Description
`$this`