Class ExportPlaybookRequest.Builder (0.94.0)

public static final class ExportPlaybookRequest.Builder extends GeneratedMessage.Builder<ExportPlaybookRequest.Builder> implements ExportPlaybookRequestOrBuilder

The request message for Playbooks.ExportPlaybook.

Protobuf type google.cloud.dialogflow.cx.v3.ExportPlaybookRequest

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

build()

public ExportPlaybookRequest build()
Returns
Type Description
ExportPlaybookRequest

buildPartial()

public ExportPlaybookRequest buildPartial()
Returns
Type Description
ExportPlaybookRequest

clear()

public ExportPlaybookRequest.Builder clear()
Returns
Type Description
ExportPlaybookRequest.Builder
Overrides

clearDataFormat()

public ExportPlaybookRequest.Builder clearDataFormat()

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

.google.cloud.dialogflow.cx.v3.ExportPlaybookRequest.DataFormat data_format = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ExportPlaybookRequest.Builder

This builder for chaining.

clearName()

public ExportPlaybookRequest.Builder clearName()

Required. The name of the playbook to export. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/playbooks/<PlaybookID>.

string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ExportPlaybookRequest.Builder

This builder for chaining.

clearPlaybookUri()

public ExportPlaybookRequest.Builder clearPlaybookUri()

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.

string playbook_uri = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ExportPlaybookRequest.Builder

This builder for chaining.

getDataFormat()

public ExportPlaybookRequest.DataFormat getDataFormat()

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

.google.cloud.dialogflow.cx.v3.ExportPlaybookRequest.DataFormat data_format = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ExportPlaybookRequest.DataFormat

The dataFormat.

getDataFormatValue()

public int getDataFormatValue()

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

.google.cloud.dialogflow.cx.v3.ExportPlaybookRequest.DataFormat data_format = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The enum numeric value on the wire for dataFormat.

getDefaultInstanceForType()

public ExportPlaybookRequest getDefaultInstanceForType()
Returns
Type Description
ExportPlaybookRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getName()

public String getName()

Required. The name of the playbook to export. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/playbooks/<PlaybookID>.

string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Required. The name of the playbook to export. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/playbooks/<PlaybookID>.

string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for name.

getPlaybookUri()

public String 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.

string playbook_uri = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The playbookUri.

getPlaybookUriBytes()

public ByteString getPlaybookUriBytes()

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.

string playbook_uri = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for playbookUri.

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(ExportPlaybookRequest other)

public ExportPlaybookRequest.Builder mergeFrom(ExportPlaybookRequest other)
Parameter
Name Description
other ExportPlaybookRequest
Returns
Type Description
ExportPlaybookRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ExportPlaybookRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ExportPlaybookRequest.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public ExportPlaybookRequest.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
ExportPlaybookRequest.Builder
Overrides

setDataFormat(ExportPlaybookRequest.DataFormat value)

public ExportPlaybookRequest.Builder setDataFormat(ExportPlaybookRequest.DataFormat value)

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

.google.cloud.dialogflow.cx.v3.ExportPlaybookRequest.DataFormat data_format = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ExportPlaybookRequest.DataFormat

The dataFormat to set.

Returns
Type Description
ExportPlaybookRequest.Builder

This builder for chaining.

setDataFormatValue(int value)

public ExportPlaybookRequest.Builder setDataFormatValue(int value)

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

.google.cloud.dialogflow.cx.v3.ExportPlaybookRequest.DataFormat data_format = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value int

The enum numeric value on the wire for dataFormat to set.

Returns
Type Description
ExportPlaybookRequest.Builder

This builder for chaining.

setName(String value)

public ExportPlaybookRequest.Builder setName(String value)

Required. The name of the playbook to export. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/playbooks/<PlaybookID>.

string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value String

The name to set.

Returns
Type Description
ExportPlaybookRequest.Builder

This builder for chaining.

setNameBytes(ByteString value)

public ExportPlaybookRequest.Builder setNameBytes(ByteString value)

Required. The name of the playbook to export. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/playbooks/<PlaybookID>.

string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value ByteString

The bytes for name to set.

Returns
Type Description
ExportPlaybookRequest.Builder

This builder for chaining.

setPlaybookUri(String value)

public ExportPlaybookRequest.Builder setPlaybookUri(String value)

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.

string playbook_uri = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The playbookUri to set.

Returns
Type Description
ExportPlaybookRequest.Builder

This builder for chaining.

setPlaybookUriBytes(ByteString value)

public ExportPlaybookRequest.Builder setPlaybookUriBytes(ByteString value)

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.

string playbook_uri = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes for playbookUri to set.

Returns
Type Description
ExportPlaybookRequest.Builder

This builder for chaining.