Class ImportClusterRequest (0.56.0)

public final class ImportClusterRequest extends GeneratedMessageV3 implements ImportClusterRequestOrBuilder

Import cluster request.

Protobuf type google.cloud.alloydb.v1.ImportClusterRequest

Static Fields

CSV_IMPORT_OPTIONS_FIELD_NUMBER

public static final int CSV_IMPORT_OPTIONS_FIELD_NUMBER
Field Value
Type Description
int

DATABASE_FIELD_NUMBER

public static final int DATABASE_FIELD_NUMBER
Field Value
Type Description
int

GCS_URI_FIELD_NUMBER

public static final int GCS_URI_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

SQL_IMPORT_OPTIONS_FIELD_NUMBER

public static final int SQL_IMPORT_OPTIONS_FIELD_NUMBER
Field Value
Type Description
int

USER_FIELD_NUMBER

public static final int USER_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static ImportClusterRequest getDefaultInstance()
Returns
Type Description
ImportClusterRequest

getDescriptor()

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

newBuilder()

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

newBuilder(ImportClusterRequest prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getCsvImportOptions()

public ImportClusterRequest.CsvImportOptions getCsvImportOptions()

Options for importing data in CSV format.

.google.cloud.alloydb.v1.ImportClusterRequest.CsvImportOptions csv_import_options = 7;

Returns
Type Description
ImportClusterRequest.CsvImportOptions

The csvImportOptions.

getCsvImportOptionsOrBuilder()

public ImportClusterRequest.CsvImportOptionsOrBuilder getCsvImportOptionsOrBuilder()

Options for importing data in CSV format.

.google.cloud.alloydb.v1.ImportClusterRequest.CsvImportOptions csv_import_options = 7;

Returns
Type Description
ImportClusterRequest.CsvImportOptionsOrBuilder

getDatabase()

public String getDatabase()

Optional. Name of the database to which the import will be done. For import from SQL file, this is required only if the file does not specify a database. 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) = OPTIONAL];

Returns
Type Description
String

The database.

getDatabaseBytes()

public ByteString getDatabaseBytes()

Optional. Name of the database to which the import will be done. For import from SQL file, this is required only if the file does not specify a database. 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) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for database.

getDefaultInstanceForType()

public ImportClusterRequest getDefaultInstanceForType()
Returns
Type Description
ImportClusterRequest

getGcsUri()

public String getGcsUri()

Required. The path to the file in Google Cloud Storage where the source file for import will be stored. The URI is in the form gs://bucketName/fileName.

string gcs_uri = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The gcsUri.

getGcsUriBytes()

public ByteString getGcsUriBytes()

Required. The path to the file in Google Cloud Storage where the source file for import will be stored. The URI is in the form gs://bucketName/fileName.

string gcs_uri = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for gcsUri.

getImportOptionsCase()

public ImportClusterRequest.ImportOptionsCase getImportOptionsCase()
Returns
Type Description
ImportClusterRequest.ImportOptionsCase

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<ImportClusterRequest> getParserForType()
Returns
Type Description
Parser<ImportClusterRequest>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getSqlImportOptions()

public ImportClusterRequest.SqlImportOptions getSqlImportOptions()

Options for importing data in SQL format.

.google.cloud.alloydb.v1.ImportClusterRequest.SqlImportOptions sql_import_options = 4;

Returns
Type Description
ImportClusterRequest.SqlImportOptions

The sqlImportOptions.

getSqlImportOptionsOrBuilder()

public ImportClusterRequest.SqlImportOptionsOrBuilder getSqlImportOptionsOrBuilder()

Options for importing data in SQL format.

.google.cloud.alloydb.v1.ImportClusterRequest.SqlImportOptions sql_import_options = 4;

Returns
Type Description
ImportClusterRequest.SqlImportOptionsOrBuilder

getUser()

public String getUser()

Optional. Database user to be used for importing the data. Note - Value provided should be the same as expected from SELECT current_user; and NOT as a resource reference.

string user = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The user.

getUserBytes()

public ByteString getUserBytes()

Optional. Database user to be used for importing the data. Note - Value provided should be the same as expected from SELECT current_user; and NOT as a resource reference.

string user = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for user.

hasCsvImportOptions()

public boolean hasCsvImportOptions()

Options for importing data in CSV format.

.google.cloud.alloydb.v1.ImportClusterRequest.CsvImportOptions csv_import_options = 7;

Returns
Type Description
boolean

Whether the csvImportOptions field is set.

hasSqlImportOptions()

public boolean hasSqlImportOptions()

Options for importing data in SQL format.

.google.cloud.alloydb.v1.ImportClusterRequest.SqlImportOptions sql_import_options = 4;

Returns
Type Description
boolean

Whether the sqlImportOptions 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 ImportClusterRequest.Builder newBuilderForType()
Returns
Type Description
ImportClusterRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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