Class ExportPlaybookRequest (0.89.0)

public final class ExportPlaybookRequest extends GeneratedMessageV3 implements ExportPlaybookRequestOrBuilder

The request message for Playbooks.ExportPlaybook.

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

Static Fields

DATA_FORMAT_FIELD_NUMBER

public static final int DATA_FORMAT_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

PLAYBOOK_URI_FIELD_NUMBER

public static final int PLAYBOOK_URI_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static ExportPlaybookRequest getDefaultInstance()
Returns
Type Description
ExportPlaybookRequest

getDescriptor()

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

newBuilder()

public static ExportPlaybookRequest.Builder newBuilder()
Returns
Type Description
ExportPlaybookRequest.Builder

newBuilder(ExportPlaybookRequest prototype)

public static ExportPlaybookRequest.Builder newBuilder(ExportPlaybookRequest prototype)
Parameter
Name Description
prototype ExportPlaybookRequest
Returns
Type Description
ExportPlaybookRequest.Builder

parseDelimitedFrom(InputStream input)

public static ExportPlaybookRequest parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ExportPlaybookRequest
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ExportPlaybookRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ExportPlaybookRequest
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static ExportPlaybookRequest parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
ExportPlaybookRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ExportPlaybookRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ExportPlaybookRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ExportPlaybookRequest parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
ExportPlaybookRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ExportPlaybookRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ExportPlaybookRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ExportPlaybookRequest parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
ExportPlaybookRequest
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ExportPlaybookRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ExportPlaybookRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static ExportPlaybookRequest parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ExportPlaybookRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ExportPlaybookRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ExportPlaybookRequest
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static ExportPlaybookRequest parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
ExportPlaybookRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ExportPlaybookRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ExportPlaybookRequest
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<ExportPlaybookRequest> parser()
Returns
Type Description
Parser<ExportPlaybookRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDataFormat()

public ExportPlaybookRequest.DataFormat getDataFormat()

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

.google.cloud.dialogflow.cx.v3beta1.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.v3beta1.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

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.

getParserForType()

public Parser<ExportPlaybookRequest> getParserForType()
Returns
Type Description
Parser<ExportPlaybookRequest>
Overrides

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.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public ExportPlaybookRequest.Builder newBuilderForType()
Returns
Type Description
ExportPlaybookRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected ExportPlaybookRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
ExportPlaybookRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public ExportPlaybookRequest.Builder toBuilder()
Returns
Type Description
ExportPlaybookRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException