Class ExportContext (0.1.0)

public final class ExportContext extends GeneratedMessage implements ExportContextOrBuilder

Database instance export context.

Protobuf type google.cloud.sql.v1beta4.ExportContext

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessage > ExportContext

Implements

ExportContextOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashCode()

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.newBuilderForType(AbstractMessage.BuilderParent)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

com.google.protobuf.GeneratedMessage.<ContainingT,T>newFileScopedGeneratedExtension(java.lang.Class<?>,com.google.protobuf.Message)

com.google.protobuf.GeneratedMessage.<ContainingT,T>newMessageScopedGeneratedExtension(com.google.protobuf.Message,int,java.lang.Class<?>,com.google.protobuf.Message)

com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT)

com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT,int)

GeneratedMessage.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessage.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessage.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessage.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessage.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessage.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

com.google.protobuf.GeneratedMessage.<T>emptyList(java.lang.Class<T>)

com.google.protobuf.GeneratedMessage.<V>serializeBooleanMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Boolean,V>,com.google.protobuf.MapEntry<java.lang.Boolean,V>,int)

com.google.protobuf.GeneratedMessage.<V>serializeIntegerMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Integer,V>,com.google.protobuf.MapEntry<java.lang.Integer,V>,int)

com.google.protobuf.GeneratedMessage.<V>serializeLongMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Long,V>,com.google.protobuf.MapEntry<java.lang.Long,V>,int)

com.google.protobuf.GeneratedMessage.<V>serializeStringMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.String,V>,com.google.protobuf.MapEntry<java.lang.String,V>,int)

com.google.protobuf.GeneratedMessage.canUseUnsafe()

GeneratedMessage.computeStringSize(int,Object)

GeneratedMessage.computeStringSizeNoTag(Object)

com.google.protobuf.GeneratedMessage.emptyBooleanList()

com.google.protobuf.GeneratedMessage.emptyDoubleList()

com.google.protobuf.GeneratedMessage.emptyFloatList()

com.google.protobuf.GeneratedMessage.emptyIntList()

com.google.protobuf.GeneratedMessage.emptyLongList()

GeneratedMessage.getAllFields()

GeneratedMessage.getDescriptorForType()

GeneratedMessage.getField(Descriptors.FieldDescriptor)

GeneratedMessage.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessage.getParserForType()

GeneratedMessage.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessage.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessage.getSerializedSize()

GeneratedMessage.getUnknownFields()

GeneratedMessage.hasField(Descriptors.FieldDescriptor)

GeneratedMessage.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessage.internalGetFieldAccessorTable()

GeneratedMessage.internalGetMapField(int)

com.google.protobuf.GeneratedMessage.internalGetMapFieldReflection(int)

GeneratedMessage.isInitialized()

com.google.protobuf.GeneratedMessage.isStringEmpty(java.lang.Object)

GeneratedMessage.makeExtensionsImmutable()

com.google.protobuf.GeneratedMessage.mergeFromAndMakeImmutableInternal(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite)

com.google.protobuf.GeneratedMessage.newInstance(com.google.protobuf.GeneratedMessage.UnusedPrivateParameter)

GeneratedMessage.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

com.google.protobuf.GeneratedMessage.parseUnknownFieldProto3(com.google.protobuf.CodedInputStream,com.google.protobuf.UnknownFieldSet.Builder,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessage.writeReplace()

GeneratedMessage.writeString(CodedOutputStream,int,Object)

GeneratedMessage.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessage.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

BAK_EXPORT_OPTIONS_FIELD_NUMBER

public static final int BAK_EXPORT_OPTIONS_FIELD_NUMBER

Field Value
Type	Description
int

CSV_EXPORT_OPTIONS_FIELD_NUMBER

public static final int CSV_EXPORT_OPTIONS_FIELD_NUMBER

Field Value
Type	Description
int

DATABASES_FIELD_NUMBER

public static final int DATABASES_FIELD_NUMBER

Field Value
Type	Description
int

FILE_TYPE_FIELD_NUMBER

public static final int FILE_TYPE_FIELD_NUMBER

Field Value
Type	Description
int

KIND_FIELD_NUMBER

public static final int KIND_FIELD_NUMBER

Field Value
Type	Description
int

OFFLOAD_FIELD_NUMBER

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

TDE_EXPORT_OPTIONS_FIELD_NUMBER

public static final int TDE_EXPORT_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 ExportContext getDefaultInstance()

Returns
Type	Description
ExportContext

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

newBuilder()

public static ExportContext.Builder newBuilder()

Returns
Type	Description
ExportContext.Builder

newBuilder(ExportContext prototype)

public static ExportContext.Builder newBuilder(ExportContext prototype)

Parameter
Name	Description
prototype	ExportContext

Returns
Type	Description
ExportContext.Builder

parseDelimitedFrom(InputStream input)

public static ExportContext parseDelimitedFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
ExportContext

Exceptions
Type	Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ExportContext parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
ExportContext

Exceptions
Type	Description
IOException

parseFrom(byte[] data)

public static ExportContext parseFrom(byte[] data)

Parameter
Name	Description
data	byte[]

Returns
Type	Description
ExportContext

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ExportContext parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	byte[]
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
ExportContext

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ExportContext parseFrom(ByteString data)

Parameter
Name	Description
data	ByteString

Returns
Type	Description
ExportContext

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ExportContext parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteString
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
ExportContext

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ExportContext parseFrom(CodedInputStream input)

Parameter
Name	Description
input	CodedInputStream

Returns
Type	Description
ExportContext

Exceptions
Type	Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ExportContext parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
ExportContext

Exceptions
Type	Description
IOException

parseFrom(InputStream input)

public static ExportContext parseFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
ExportContext

Exceptions
Type	Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ExportContext parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
ExportContext

Exceptions
Type	Description
IOException

parseFrom(ByteBuffer data)

public static ExportContext parseFrom(ByteBuffer data)

Parameter
Name	Description
data	ByteBuffer

Returns
Type	Description
ExportContext

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ExportContext parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteBuffer
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
ExportContext

Exceptions
Type	Description
InvalidProtocolBufferException

parser()

public static Parser<ExportContext> parser()

Returns
Type	Description
Parser<ExportContext>

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter
Name	Description
obj	Object

Returns
Type	Description
boolean

Overrides

AbstractMessage.equals(Object other)

getBakExportOptions()

public ExportContext.SqlBakExportOptions getBakExportOptions()

Options for exporting data as BAK files.

.google.cloud.sql.v1beta4.ExportContext.SqlBakExportOptions bak_export_options = 9;

Returns
Type	Description
ExportContext.SqlBakExportOptions	The bakExportOptions.

getBakExportOptionsOrBuilder()

public ExportContext.SqlBakExportOptionsOrBuilder getBakExportOptionsOrBuilder()

Options for exporting data as BAK files.

.google.cloud.sql.v1beta4.ExportContext.SqlBakExportOptions bak_export_options = 9;

Returns
Type	Description
ExportContext.SqlBakExportOptionsOrBuilder

getCsvExportOptions()

public ExportContext.SqlCsvExportOptions getCsvExportOptions()

Options for exporting data as CSV. MySQL and PostgreSQL instances only.

.google.cloud.sql.v1beta4.ExportContext.SqlCsvExportOptions csv_export_options = 5;

Returns
Type	Description
ExportContext.SqlCsvExportOptions	The csvExportOptions.

getCsvExportOptionsOrBuilder()

public ExportContext.SqlCsvExportOptionsOrBuilder getCsvExportOptionsOrBuilder()

Options for exporting data as CSV. MySQL and PostgreSQL instances only.

.google.cloud.sql.v1beta4.ExportContext.SqlCsvExportOptions csv_export_options = 5;

Returns
Type	Description
ExportContext.SqlCsvExportOptionsOrBuilder

getDatabases(int index)

public String getDatabases(int index)

Databases to be exported. <br /> MySQL instances: If fileType is SQL and no database is specified, all databases are exported, except for the mysql system database. If fileType is CSV, you can specify one database, either by using this property or by using the csvExportOptions.selectQuery property, which takes precedence over this property. <br /> PostgreSQL instances: If you don't specify a database by name, all user databases in the instance are exported. This excludes system databases and Cloud SQL databases used to manage internal operations. Exporting all user databases is only available for directory-formatted parallel export. If fileType is CSV, this database must match the one specified in the csvExportOptions.selectQuery property. <br /> SQL Server instances: You must specify one database to be exported, and the fileType must be BAK.

repeated string databases = 2;

Parameter
Name	Description
index	int The index of the element to return.

Returns
Type	Description
String	The databases at the given index.

getDatabasesBytes(int index)

public ByteString getDatabasesBytes(int index)

Databases to be exported. <br /> MySQL instances: If fileType is SQL and no database is specified, all databases are exported, except for the mysql system database. If fileType is CSV, you can specify one database, either by using this property or by using the csvExportOptions.selectQuery property, which takes precedence over this property. <br /> PostgreSQL instances: If you don't specify a database by name, all user databases in the instance are exported. This excludes system databases and Cloud SQL databases used to manage internal operations. Exporting all user databases is only available for directory-formatted parallel export. If fileType is CSV, this database must match the one specified in the csvExportOptions.selectQuery property. <br /> SQL Server instances: You must specify one database to be exported, and the fileType must be BAK.

repeated string databases = 2;

Parameter
Name	Description
index	int The index of the value to return.

Returns
Type	Description
ByteString	The bytes of the databases at the given index.

getDatabasesCount()

public int getDatabasesCount()

Databases to be exported. <br /> MySQL instances: If fileType is SQL and no database is specified, all databases are exported, except for the mysql system database. If fileType is CSV, you can specify one database, either by using this property or by using the csvExportOptions.selectQuery property, which takes precedence over this property. <br /> PostgreSQL instances: If you don't specify a database by name, all user databases in the instance are exported. This excludes system databases and Cloud SQL databases used to manage internal operations. Exporting all user databases is only available for directory-formatted parallel export. If fileType is CSV, this database must match the one specified in the csvExportOptions.selectQuery property. <br /> SQL Server instances: You must specify one database to be exported, and the fileType must be BAK.

repeated string databases = 2;

Returns
Type	Description
int	The count of databases.

getDatabasesList()

public ProtocolStringList getDatabasesList()

Databases to be exported. <br /> MySQL instances: If fileType is SQL and no database is specified, all databases are exported, except for the mysql system database. If fileType is CSV, you can specify one database, either by using this property or by using the csvExportOptions.selectQuery property, which takes precedence over this property. <br /> PostgreSQL instances: If you don't specify a database by name, all user databases in the instance are exported. This excludes system databases and Cloud SQL databases used to manage internal operations. Exporting all user databases is only available for directory-formatted parallel export. If fileType is CSV, this database must match the one specified in the csvExportOptions.selectQuery property. <br /> SQL Server instances: You must specify one database to be exported, and the fileType must be BAK.

repeated string databases = 2;

Returns
Type	Description
ProtocolStringList	A list containing the databases.

getDefaultInstanceForType()

public ExportContext getDefaultInstanceForType()

Returns
Type	Description
ExportContext

getFileType()

public SqlFileType getFileType()

The file type for the specified uri.

.google.cloud.sql.v1beta4.SqlFileType file_type = 6;

Returns
Type	Description
SqlFileType	The fileType.

getFileTypeValue()

public int getFileTypeValue()

The file type for the specified uri.

.google.cloud.sql.v1beta4.SqlFileType file_type = 6;

Returns
Type	Description
int	The enum numeric value on the wire for fileType.

getKind()

public String getKind()

This is always sql#exportContext.

string kind = 3;

Returns
Type	Description
String	The kind.

getKindBytes()

public ByteString getKindBytes()

This is always sql#exportContext.

string kind = 3;

Returns
Type	Description
ByteString	The bytes for kind.

getOffload()

public BoolValue getOffload()

Whether to perform a serverless export.

.google.protobuf.BoolValue offload = 8;

Returns
Type	Description
BoolValue	The offload.

getOffloadOrBuilder()

public BoolValueOrBuilder getOffloadOrBuilder()

Whether to perform a serverless export.

.google.protobuf.BoolValue offload = 8;

Returns
Type	Description
BoolValueOrBuilder

getParserForType()

public Parser<ExportContext> getParserForType()

Returns
Type	Description
Parser<ExportContext>

Overrides

GeneratedMessage.getParserForType()

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
int

Overrides

GeneratedMessage.getSerializedSize()

getSqlExportOptions()

public ExportContext.SqlExportOptions getSqlExportOptions()

Options for exporting data as SQL statements.

.google.cloud.sql.v1beta4.ExportContext.SqlExportOptions sql_export_options = 4;

Returns
Type	Description
ExportContext.SqlExportOptions	The sqlExportOptions.

getSqlExportOptionsOrBuilder()

public ExportContext.SqlExportOptionsOrBuilder getSqlExportOptionsOrBuilder()

Options for exporting data as SQL statements.

.google.cloud.sql.v1beta4.ExportContext.SqlExportOptions sql_export_options = 4;

Returns
Type	Description
ExportContext.SqlExportOptionsOrBuilder

getTdeExportOptions()

public ExportContext.SqlTdeExportOptions getTdeExportOptions()

Optional. Export parameters specific to SQL Server TDE certificates

.google.cloud.sql.v1beta4.ExportContext.SqlTdeExportOptions tde_export_options = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ExportContext.SqlTdeExportOptions	The tdeExportOptions.

getTdeExportOptionsOrBuilder()

public ExportContext.SqlTdeExportOptionsOrBuilder getTdeExportOptionsOrBuilder()

Optional. Export parameters specific to SQL Server TDE certificates

.google.cloud.sql.v1beta4.ExportContext.SqlTdeExportOptions tde_export_options = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ExportContext.SqlTdeExportOptionsOrBuilder

getUri()

public String getUri()

The path to the file in Google Cloud Storage where the export will be stored. The URI is in the form gs://bucketName/fileName. If the file already exists, the request succeeds, but the operation fails. If fileType is SQL and the filename ends with .gz, the contents are compressed.

string uri = 1;

Returns
Type	Description
String	The uri.

getUriBytes()

public ByteString getUriBytes()

The path to the file in Google Cloud Storage where the export will be stored. The URI is in the form gs://bucketName/fileName. If the file already exists, the request succeeds, but the operation fails. If fileType is SQL and the filename ends with .gz, the contents are compressed.

string uri = 1;

Returns
Type	Description
ByteString	The bytes for uri.

hasBakExportOptions()

public boolean hasBakExportOptions()

Options for exporting data as BAK files.

.google.cloud.sql.v1beta4.ExportContext.SqlBakExportOptions bak_export_options = 9;

Returns
Type	Description
boolean	Whether the bakExportOptions field is set.

hasCsvExportOptions()

public boolean hasCsvExportOptions()

Options for exporting data as CSV. MySQL and PostgreSQL instances only.

.google.cloud.sql.v1beta4.ExportContext.SqlCsvExportOptions csv_export_options = 5;

Returns
Type	Description
boolean	Whether the csvExportOptions field is set.

hasOffload()

public boolean hasOffload()

Whether to perform a serverless export.

.google.protobuf.BoolValue offload = 8;

Returns
Type	Description
boolean	Whether the offload field is set.

hasSqlExportOptions()

public boolean hasSqlExportOptions()

Options for exporting data as SQL statements.

.google.cloud.sql.v1beta4.ExportContext.SqlExportOptions sql_export_options = 4;

Returns
Type	Description
boolean	Whether the sqlExportOptions field is set.

hasTdeExportOptions()

public boolean hasTdeExportOptions()

Optional. Export parameters specific to SQL Server TDE certificates

.google.cloud.sql.v1beta4.ExportContext.SqlTdeExportOptions tde_export_options = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the tdeExportOptions field is set.

hashCode()

public int hashCode()

Returns
Type	Description
int

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessage.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessage.isInitialized()

newBuilderForType()

public ExportContext.Builder newBuilderForType()

Returns
Type	Description
ExportContext.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

protected ExportContext.Builder newBuilderForType(AbstractMessage.BuilderParent parent)

Parameter
Name	Description
parent	BuilderParent

Returns
Type	Description
ExportContext.Builder

Overrides

AbstractMessage.newBuilderForType(AbstractMessage.BuilderParent parent)

toBuilder()

public ExportContext.Builder toBuilder()

Returns
Type	Description
ExportContext.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
output	CodedOutputStream

Overrides

GeneratedMessage.writeTo(CodedOutputStream output)

Exceptions
Type	Description
IOException