com.google.api.services.sqladmin.model

Class ExportContext

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.sqladmin.model.ExportContext

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class ExportContext
extends com.google.api.client.json.GenericJson

Database instance export context.

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Cloud SQL Admin API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ExportContext.BakExportOptions Options for exporting BAK files (SQL Server-only)
static class	ExportContext.CsvExportOptions Options for exporting data as CSV.
static class	ExportContext.SqlExportOptions Options for exporting data as SQL statements.

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

com.google.api.client.util.GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
ExportContext()

Method Summary

Modifier and Type	Method and Description
ExportContext	clone()
ExportContext.BakExportOptions	getBakExportOptions() Options for exporting BAK files (SQL Server-only)
ExportContext.CsvExportOptions	getCsvExportOptions() Options for exporting data as CSV.
List<String>	getDatabases() Databases to be exported.
String	getFileType() The file type for the specified uri.
String	getKind() This is always `sql#exportContext`.
Boolean	getOffload() Option for export offload.
ExportContext.SqlExportOptions	getSqlExportOptions() Options for exporting data as SQL statements.
String	getUri() The path to the file in Google Cloud Storage where the export will be stored.
ExportContext	set(String fieldName, Object value)
ExportContext	setBakExportOptions(ExportContext.BakExportOptions bakExportOptions) Options for exporting BAK files (SQL Server-only)
ExportContext	setCsvExportOptions(ExportContext.CsvExportOptions csvExportOptions) Options for exporting data as CSV.
ExportContext	setDatabases(List<String> databases) Databases to be exported.
ExportContext	setFileType(String fileType) The file type for the specified uri.
ExportContext	setKind(String kind) This is always `sql#exportContext`.
ExportContext	setOffload(Boolean offload) Option for export offload.
ExportContext	setSqlExportOptions(ExportContext.SqlExportOptions sqlExportOptions) Options for exporting data as SQL statements.
ExportContext	setUri(String uri) The path to the file in Google Cloud Storage where the export will be stored.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

ExportContext

public ExportContext()

Method Detail

getBakExportOptions

public ExportContext.BakExportOptions getBakExportOptions()

Options for exporting BAK files (SQL Server-only)

Returns:

value or null for none

setBakExportOptions

public ExportContext setBakExportOptions(ExportContext.BakExportOptions bakExportOptions)

Options for exporting BAK files (SQL Server-only)

Parameters:

bakExportOptions - bakExportOptions or null for none

getCsvExportOptions

public ExportContext.CsvExportOptions getCsvExportOptions()

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

Returns:

value or null for none

setCsvExportOptions

public ExportContext setCsvExportOptions(ExportContext.CsvExportOptions csvExportOptions)

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

Parameters:

csvExportOptions - csvExportOptions or null for none

getDatabases

public List<String> getDatabases()

Databases to be exported. `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. `PostgreSQL instances:` You must specify one database to be exported. If `fileType` is `CSV`, this database must match the one specified in the `csvExportOptions.selectQuery` property. `SQL Server instances:` You must specify one database to be exported, and the `fileType` must be `BAK`.

Returns:

value or null for none

setDatabases

public ExportContext setDatabases(List<String> databases)

Databases to be exported. `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. `PostgreSQL instances:` You must specify one database to be exported. If `fileType` is `CSV`, this database must match the one specified in the `csvExportOptions.selectQuery` property. `SQL Server instances:` You must specify one database to be exported, and the `fileType` must be `BAK`.

Parameters:

databases - databases or null for none

getFileType

public String getFileType()

The file type for the specified uri.

Returns:

value or null for none

setFileType

public ExportContext setFileType(String fileType)

The file type for the specified uri.

Parameters:

fileType - fileType or null for none

getKind

public String getKind()

This is always `sql#exportContext`.

Returns:

value or null for none

setKind

public ExportContext setKind(String kind)

This is always `sql#exportContext`.

Parameters:

kind - kind or null for none

getOffload

public Boolean getOffload()

Option for export offload.

Returns:

value or null for none

setOffload

public ExportContext setOffload(Boolean offload)

Option for export offload.

Parameters:

offload - offload or null for none

getSqlExportOptions

public ExportContext.SqlExportOptions getSqlExportOptions()

Options for exporting data as SQL statements.

Returns:

value or null for none

setSqlExportOptions

public ExportContext setSqlExportOptions(ExportContext.SqlExportOptions sqlExportOptions)

Options for exporting data as SQL statements.

Parameters:

sqlExportOptions - sqlExportOptions or null for none

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.

Returns:

value or null for none

setUri

public ExportContext setUri(String uri)

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.

Parameters:

uri - uri or null for none

set

public ExportContext set(String fieldName,
                         Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public ExportContext clone()

Overrides:

clone in class com.google.api.client.json.GenericJson