Class ExportClusterRequest (0.56.0)

public final class ExportClusterRequest extends GeneratedMessageV3 implements ExportClusterRequestOrBuilder

Export cluster request.

Protobuf type google.cloud.alloydb.v1.ExportClusterRequest

Static Fields

CSV_EXPORT_OPTIONS_FIELD_NUMBER

public static final int CSV_EXPORT_OPTIONS_FIELD_NUMBER
Field Value
Type Description
int

DATABASE_FIELD_NUMBER

public static final int DATABASE_FIELD_NUMBER
Field Value
Type Description
int

GCS_DESTINATION_FIELD_NUMBER

public static final int GCS_DESTINATION_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

SQL_EXPORT_OPTIONS_FIELD_NUMBER

public static final int SQL_EXPORT_OPTIONS_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static ExportClusterRequest getDefaultInstance()
Returns
Type Description
ExportClusterRequest

getDescriptor()

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

newBuilder()

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

newBuilder(ExportClusterRequest prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getCsvExportOptions()

public ExportClusterRequest.CsvExportOptions getCsvExportOptions()

Options for exporting data in CSV format. Required field to be set for CSV file type.

.google.cloud.alloydb.v1.ExportClusterRequest.CsvExportOptions csv_export_options = 4;

Returns
Type Description
ExportClusterRequest.CsvExportOptions

The csvExportOptions.

getCsvExportOptionsOrBuilder()

public ExportClusterRequest.CsvExportOptionsOrBuilder getCsvExportOptionsOrBuilder()

Options for exporting data in CSV format. Required field to be set for CSV file type.

.google.cloud.alloydb.v1.ExportClusterRequest.CsvExportOptions csv_export_options = 4;

Returns
Type Description
ExportClusterRequest.CsvExportOptionsOrBuilder

getDatabase()

public String getDatabase()

Required. Name of the database where the export command will be executed. Note - Value provided should be the same as expected from SELECT current_database(); and NOT as a resource reference.

string database = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The database.

getDatabaseBytes()

public ByteString getDatabaseBytes()

Required. Name of the database where the export command will be executed. Note - Value provided should be the same as expected from SELECT current_database(); and NOT as a resource reference.

string database = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for database.

getDefaultInstanceForType()

public ExportClusterRequest getDefaultInstanceForType()
Returns
Type Description
ExportClusterRequest

getDestinationCase()

public ExportClusterRequest.DestinationCase getDestinationCase()
Returns
Type Description
ExportClusterRequest.DestinationCase

getExportOptionsCase()

public ExportClusterRequest.ExportOptionsCase getExportOptionsCase()
Returns
Type Description
ExportClusterRequest.ExportOptionsCase

getGcsDestination()

public GcsDestination getGcsDestination()

Required. Option to export data to cloud storage.

.google.cloud.alloydb.v1.GcsDestination gcs_destination = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
GcsDestination

The gcsDestination.

getGcsDestinationOrBuilder()

public GcsDestinationOrBuilder getGcsDestinationOrBuilder()

Required. Option to export data to cloud storage.

.google.cloud.alloydb.v1.GcsDestination gcs_destination = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
GcsDestinationOrBuilder

getName()

public String getName()

Required. The resource name of the cluster.

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

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Required. The resource name of the cluster.

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

Returns
Type Description
ByteString

The bytes for name.

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getSqlExportOptions()

public ExportClusterRequest.SqlExportOptions getSqlExportOptions()

Options for exporting data in SQL format. Required field to be set for SQL file type.

.google.cloud.alloydb.v1.ExportClusterRequest.SqlExportOptions sql_export_options = 5;

Returns
Type Description
ExportClusterRequest.SqlExportOptions

The sqlExportOptions.

getSqlExportOptionsOrBuilder()

public ExportClusterRequest.SqlExportOptionsOrBuilder getSqlExportOptionsOrBuilder()

Options for exporting data in SQL format. Required field to be set for SQL file type.

.google.cloud.alloydb.v1.ExportClusterRequest.SqlExportOptions sql_export_options = 5;

Returns
Type Description
ExportClusterRequest.SqlExportOptionsOrBuilder

hasCsvExportOptions()

public boolean hasCsvExportOptions()

Options for exporting data in CSV format. Required field to be set for CSV file type.

.google.cloud.alloydb.v1.ExportClusterRequest.CsvExportOptions csv_export_options = 4;

Returns
Type Description
boolean

Whether the csvExportOptions field is set.

hasGcsDestination()

public boolean hasGcsDestination()

Required. Option to export data to cloud storage.

.google.cloud.alloydb.v1.GcsDestination gcs_destination = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the gcsDestination field is set.

hasSqlExportOptions()

public boolean hasSqlExportOptions()

Options for exporting data in SQL format. Required field to be set for SQL file type.

.google.cloud.alloydb.v1.ExportClusterRequest.SqlExportOptions sql_export_options = 5;

Returns
Type Description
boolean

Whether the sqlExportOptions field is set.

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 ExportClusterRequest.Builder newBuilderForType()
Returns
Type Description
ExportClusterRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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