Google Cloud Dialogflow Cx V3 Client - Class RestoreAgentRequest (0.2.1)

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

The request message for Agents.RestoreAgent.

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

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 restore into. Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>`.
`↳ agent_uri`	`string` The Google Cloud Storage URI to restore agent from. The format of this URI must be `gs://<bucket-name>/<object-name>`. Dialogflow performs a read operation for the Cloud Storage object on the caller's behalf, so your request authentication must have read permissions for the object. For more information, see Dialogflow access control.
`↳ agent_content`	`string` Uncompressed raw byte content for agent.
`↳ git_source`	`Google\Cloud\Dialogflow\Cx\V3\RestoreAgentRequest\GitSource` Setting for restoring from a git branch
`↳ restore_option`	`int` Agent restore mode. If not specified, `KEEP` is assumed.

getName

Required. The name of the agent to restore into.

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

Returns
Type	Description
`string`

setName

Required. The name of the agent to restore into.

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

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getAgentUri

The Google Cloud Storage URI to restore agent from. The format of this URI must be gs://<bucket-name>/<object-name>.

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

Returns
Type	Description
`string`

hasAgentUri

setAgentUri

The Google Cloud Storage URI to restore agent from. The format of this URI must be gs://<bucket-name>/<object-name>.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getAgentContent

Uncompressed raw byte content for agent.

Returns
Type	Description
`string`

hasAgentContent

setAgentContent

Uncompressed raw byte content for agent.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getGitSource

Setting for restoring from a git branch

Returns
Type	Description
`Google\Cloud\Dialogflow\Cx\V3\RestoreAgentRequest\GitSource\|null`

hasGitSource

setGitSource

Setting for restoring from a git branch

Parameter
Name	Description
`var`	`Google\Cloud\Dialogflow\Cx\V3\RestoreAgentRequest\GitSource`

Returns
Type	Description
`$this`

getRestoreOption

Agent restore mode. If not specified, KEEP is assumed.

Returns
Type	Description
`int`

setRestoreOption

Agent restore mode. If not specified, KEEP is assumed.

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`

getAgent

Returns
Type	Description
`string`