Google Cloud Dialogflow Cx V3 Client - Class ExportPlaybookRequest (0.10.1)

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

The request message for Playbooks.ExportPlaybook.

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

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 playbook to export. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/playbooks/<PlaybookID>.
↳ playbook_uri string

Optional. The Google Cloud Storage URI to export the playbook to. The format of this URI must be gs://<bucket-name>/<object-name>. If left unspecified, the serialized playbook 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.

getName

Required. The name of the playbook to export.

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

Returns
Type Description
string

setName

Required. The name of the playbook to export.

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

Parameter
Name Description
var string
Returns
Type Description
$this

getPlaybookUri

Optional. The Google Cloud Storage URI to export the playbook to. The format of this URI must be gs://<bucket-name>/<object-name>. If left unspecified, the serialized playbook 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

setPlaybookUri

Optional. The Google Cloud Storage URI to export the playbook to. The format of this URI must be gs://<bucket-name>/<object-name>. If left unspecified, the serialized playbook 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.

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 Enum of type DataFormat.

setDataFormat

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

Parameter
Name Description
var int

Enum of type DataFormat.

Returns
Type Description
$this