Interface ExportContextOrBuilder (0.1.0)

public interface ExportContextOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getBakExportOptions()

public abstract ExportContext.SqlBakExportOptions getBakExportOptions()

Options for exporting data as BAK files.

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

Returns
Type	Description
ExportContext.SqlBakExportOptions	The bakExportOptions.

getBakExportOptionsOrBuilder()

public abstract ExportContext.SqlBakExportOptionsOrBuilder getBakExportOptionsOrBuilder()

Options for exporting data as BAK files.

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

Returns
Type	Description
ExportContext.SqlBakExportOptionsOrBuilder

getCsvExportOptions()

public abstract ExportContext.SqlCsvExportOptions getCsvExportOptions()

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

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

Returns
Type	Description
ExportContext.SqlCsvExportOptions	The csvExportOptions.

getCsvExportOptionsOrBuilder()

public abstract ExportContext.SqlCsvExportOptionsOrBuilder getCsvExportOptionsOrBuilder()

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

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

Returns
Type	Description
ExportContext.SqlCsvExportOptionsOrBuilder

getDatabases(int index)

public abstract 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 abstract 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 abstract 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 abstract List<String> 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
List<String>	A list containing the databases.

getFileType()

public abstract SqlFileType getFileType()

The file type for the specified uri.

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

Returns
Type	Description
SqlFileType	The fileType.

getFileTypeValue()

public abstract int getFileTypeValue()

The file type for the specified uri.

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

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

getKind()

public abstract String getKind()

This is always sql#exportContext.

string kind = 3;

Returns
Type	Description
String	The kind.

getKindBytes()

public abstract ByteString getKindBytes()

This is always sql#exportContext.

string kind = 3;

Returns
Type	Description
ByteString	The bytes for kind.

getOffload()

public abstract BoolValue getOffload()

Whether to perform a serverless export.

.google.protobuf.BoolValue offload = 8;

Returns
Type	Description
BoolValue	The offload.

getOffloadOrBuilder()

public abstract BoolValueOrBuilder getOffloadOrBuilder()

Whether to perform a serverless export.

.google.protobuf.BoolValue offload = 8;

Returns
Type	Description
BoolValueOrBuilder

getSqlExportOptions()

public abstract ExportContext.SqlExportOptions getSqlExportOptions()

Options for exporting data as SQL statements.

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

Returns
Type	Description
ExportContext.SqlExportOptions	The sqlExportOptions.

getSqlExportOptionsOrBuilder()

public abstract ExportContext.SqlExportOptionsOrBuilder getSqlExportOptionsOrBuilder()

Options for exporting data as SQL statements.

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

Returns
Type	Description
ExportContext.SqlExportOptionsOrBuilder

getTdeExportOptions()

public abstract ExportContext.SqlTdeExportOptions getTdeExportOptions()

Optional. Export parameters specific to SQL Server TDE certificates

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

Returns
Type	Description
ExportContext.SqlTdeExportOptions	The tdeExportOptions.

getTdeExportOptionsOrBuilder()

public abstract ExportContext.SqlTdeExportOptionsOrBuilder getTdeExportOptionsOrBuilder()

Optional. Export parameters specific to SQL Server TDE certificates

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

Returns
Type	Description
ExportContext.SqlTdeExportOptionsOrBuilder

getUri()

public abstract 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 abstract 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 abstract boolean hasBakExportOptions()

Options for exporting data as BAK files.

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

Returns
Type	Description
boolean	Whether the bakExportOptions field is set.

hasCsvExportOptions()

public abstract boolean hasCsvExportOptions()

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

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

Returns
Type	Description
boolean	Whether the csvExportOptions field is set.

hasOffload()

public abstract 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 abstract boolean hasSqlExportOptions()

Options for exporting data as SQL statements.

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

Returns
Type	Description
boolean	Whether the sqlExportOptions field is set.

hasTdeExportOptions()

public abstract boolean hasTdeExportOptions()

Optional. Export parameters specific to SQL Server TDE certificates

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

Returns
Type	Description
boolean	Whether the tdeExportOptions field is set.