Class ImportContext (0.1.0)

public final class ImportContext extends GeneratedMessage implements ImportContextOrBuilder

Database instance import context.

Protobuf type google.cloud.sql.v1.ImportContext

Static Fields

BAK_IMPORT_OPTIONS_FIELD_NUMBER

public static final int BAK_IMPORT_OPTIONS_FIELD_NUMBER
Field Value
Type Description
int

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

FILE_TYPE_FIELD_NUMBER

public static final int FILE_TYPE_FIELD_NUMBER
Field Value
Type Description
int

IMPORT_USER_FIELD_NUMBER

public static final int IMPORT_USER_FIELD_NUMBER
Field Value
Type Description
int

KIND_FIELD_NUMBER

public static final int KIND_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

TDE_IMPORT_OPTIONS_FIELD_NUMBER

public static final int TDE_IMPORT_OPTIONS_FIELD_NUMBER
Field Value
Type Description
int

URI_FIELD_NUMBER

public static final int URI_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static ImportContext getDefaultInstance()
Returns
Type Description
ImportContext

getDescriptor()

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

newBuilder()

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

newBuilder(ImportContext prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getBakImportOptions()

public ImportContext.SqlBakImportOptions getBakImportOptions()

Import parameters specific to SQL Server .BAK files

.google.cloud.sql.v1.ImportContext.SqlBakImportOptions bak_import_options = 7;

Returns
Type Description
ImportContext.SqlBakImportOptions

The bakImportOptions.

getBakImportOptionsOrBuilder()

public ImportContext.SqlBakImportOptionsOrBuilder getBakImportOptionsOrBuilder()

Import parameters specific to SQL Server .BAK files

.google.cloud.sql.v1.ImportContext.SqlBakImportOptions bak_import_options = 7;

Returns
Type Description
ImportContext.SqlBakImportOptionsOrBuilder

getCsvImportOptions()

public ImportContext.SqlCsvImportOptions getCsvImportOptions()

Options for importing data as CSV.

.google.cloud.sql.v1.ImportContext.SqlCsvImportOptions csv_import_options = 5;

Returns
Type Description
ImportContext.SqlCsvImportOptions

The csvImportOptions.

getCsvImportOptionsOrBuilder()

public ImportContext.SqlCsvImportOptionsOrBuilder getCsvImportOptionsOrBuilder()

Options for importing data as CSV.

.google.cloud.sql.v1.ImportContext.SqlCsvImportOptions csv_import_options = 5;

Returns
Type Description
ImportContext.SqlCsvImportOptionsOrBuilder

getDatabase()

public String getDatabase()

The target database for the import. If fileType is SQL, this field is required only if the import file does not specify a database, and is overridden by any database specification in the import file. For entire instance parallel import operations, the database is overridden by the database name stored in subdirectory name. If fileType is CSV, one database must be specified.

string database = 2;

Returns
Type Description
String

The database.

getDatabaseBytes()

public ByteString getDatabaseBytes()

The target database for the import. If fileType is SQL, this field is required only if the import file does not specify a database, and is overridden by any database specification in the import file. For entire instance parallel import operations, the database is overridden by the database name stored in subdirectory name. If fileType is CSV, one database must be specified.

string database = 2;

Returns
Type Description
ByteString

The bytes for database.

getDefaultInstanceForType()

public ImportContext getDefaultInstanceForType()
Returns
Type Description
ImportContext

getFileType()

public SqlFileType getFileType()

The file type for the specified uri.\SQL: The file contains SQL statements. \CSV: The file contains CSV data.

.google.cloud.sql.v1.SqlFileType file_type = 4;

Returns
Type Description
SqlFileType

The fileType.

getFileTypeValue()

public int getFileTypeValue()

The file type for the specified uri.\SQL: The file contains SQL statements. \CSV: The file contains CSV data.

.google.cloud.sql.v1.SqlFileType file_type = 4;

Returns
Type Description
int

The enum numeric value on the wire for fileType.

getImportUser()

public String getImportUser()

The PostgreSQL user for this import operation. PostgreSQL instances only.

string import_user = 6;

Returns
Type Description
String

The importUser.

getImportUserBytes()

public ByteString getImportUserBytes()

The PostgreSQL user for this import operation. PostgreSQL instances only.

string import_user = 6;

Returns
Type Description
ByteString

The bytes for importUser.

getKind()

public String getKind()

This is always sql#importContext.

string kind = 3;

Returns
Type Description
String

The kind.

getKindBytes()

public ByteString getKindBytes()

This is always sql#importContext.

string kind = 3;

Returns
Type Description
ByteString

The bytes for kind.

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getSqlImportOptions()

public ImportContext.SqlImportOptions getSqlImportOptions()

Optional. Options for importing data from SQL statements.

.google.cloud.sql.v1.ImportContext.SqlImportOptions sql_import_options = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ImportContext.SqlImportOptions

The sqlImportOptions.

getSqlImportOptionsOrBuilder()

public ImportContext.SqlImportOptionsOrBuilder getSqlImportOptionsOrBuilder()

Optional. Options for importing data from SQL statements.

.google.cloud.sql.v1.ImportContext.SqlImportOptions sql_import_options = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ImportContext.SqlImportOptionsOrBuilder

getTdeImportOptions()

public ImportContext.SqlTdeImportOptions getTdeImportOptions()

Optional. Import parameters specific to SQL Server TDE certificates

.google.cloud.sql.v1.ImportContext.SqlTdeImportOptions tde_import_options = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ImportContext.SqlTdeImportOptions

The tdeImportOptions.

getTdeImportOptionsOrBuilder()

public ImportContext.SqlTdeImportOptionsOrBuilder getTdeImportOptionsOrBuilder()

Optional. Import parameters specific to SQL Server TDE certificates

.google.cloud.sql.v1.ImportContext.SqlTdeImportOptions tde_import_options = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ImportContext.SqlTdeImportOptionsOrBuilder

getUri()

public String getUri()

Path to the import file in Cloud Storage, in the form gs://bucketName/fileName. Compressed gzip files (.gz) are supported when fileType is SQL. The instance must have write permissions to the bucket and read access to the file.

string uri = 1;

Returns
Type Description
String

The uri.

getUriBytes()

public ByteString getUriBytes()

Path to the import file in Cloud Storage, in the form gs://bucketName/fileName. Compressed gzip files (.gz) are supported when fileType is SQL. The instance must have write permissions to the bucket and read access to the file.

string uri = 1;

Returns
Type Description
ByteString

The bytes for uri.

hasBakImportOptions()

public boolean hasBakImportOptions()

Import parameters specific to SQL Server .BAK files

.google.cloud.sql.v1.ImportContext.SqlBakImportOptions bak_import_options = 7;

Returns
Type Description
boolean

Whether the bakImportOptions field is set.

hasCsvImportOptions()

public boolean hasCsvImportOptions()

Options for importing data as CSV.

.google.cloud.sql.v1.ImportContext.SqlCsvImportOptions csv_import_options = 5;

Returns
Type Description
boolean

Whether the csvImportOptions field is set.

hasSqlImportOptions()

public boolean hasSqlImportOptions()

Optional. Options for importing data from SQL statements.

.google.cloud.sql.v1.ImportContext.SqlImportOptions sql_import_options = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the sqlImportOptions field is set.

hasTdeImportOptions()

public boolean hasTdeImportOptions()

Optional. Import parameters specific to SQL Server TDE certificates

.google.cloud.sql.v1.ImportContext.SqlTdeImportOptions tde_import_options = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the tdeImportOptions field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

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

newBuilderForType(AbstractMessage.BuilderParent parent)

protected ImportContext.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
ImportContext.Builder
Overrides

toBuilder()

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

writeTo(CodedOutputStream output)

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