Class ExportAgentRequest (0.16.0)

public final class ExportAgentRequest extends GeneratedMessageV3 implements ExportAgentRequestOrBuilder

The request message for Agents.ExportAgent.

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

Static Fields

AGENT_URI_FIELD_NUMBER

public static final int AGENT_URI_FIELD_NUMBER
Field Value
Type Description
int

DATA_FORMAT_FIELD_NUMBER

public static final int DATA_FORMAT_FIELD_NUMBER
Field Value
Type Description
int

ENVIRONMENT_FIELD_NUMBER

public static final int ENVIRONMENT_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static ExportAgentRequest getDefaultInstance()
Returns
Type Description
ExportAgentRequest

getDescriptor()

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

newBuilder()

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

newBuilder(ExportAgentRequest prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getAgentUri()

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

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

Returns
Type Description
String

The agentUri.

getAgentUriBytes()

public ByteString getAgentUriBytes()

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.

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

Returns
Type Description
ByteString

The bytes for agentUri.

getDataFormat()

public ExportAgentRequest.DataFormat getDataFormat()

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

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

Returns
Type Description
ExportAgentRequest.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.ExportAgentRequest.DataFormat data_format = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The enum numeric value on the wire for dataFormat.

getDefaultInstanceForType()

public ExportAgentRequest getDefaultInstanceForType()
Returns
Type Description
ExportAgentRequest

getEnvironment()

public String getEnvironment()

Optional. Environment name. If not set, draft environment is assumed. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment ID>.

string environment = 5 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The environment.

getEnvironmentBytes()

public ByteString getEnvironmentBytes()

Optional. Environment name. If not set, draft environment is assumed. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment ID>.

string environment = 5 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for environment.

getName()

public String getName()

Required. The name of the agent to export. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>.

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 agent to export. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>.

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

Returns
Type Description
ByteString

The bytes for name.

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
Type Description
UnknownFieldSet
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 ExportAgentRequest.Builder newBuilderForType()
Returns
Type Description
ExportAgentRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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