#include <export_context.h>

Inheritance diagram for google_sqladmin_api::ExportContext:

Classes
class	ExportContextCsvExportOptions

class	ExportContextSqlExportOptions

Public Member Functions
	ExportContext (const Json::Value &storage)

	ExportContext (Json::Value *storage)

virtual	~ExportContext ()

const StringPiece	GetTypeName () const

bool	has_csv_export_options () const

void	clear_csv_export_options ()

const ExportContextCsvExportOptions	get_csv_export_options () const

ExportContextCsvExportOptions	mutable_csvExportOptions ()

bool	has_databases () const

void	clear_databases ()

const client::JsonCppArray< string >	get_databases () const

client::JsonCppArray< string >	mutable_databases ()

bool	has_file_type () const

void	clear_file_type ()

const StringPiece	get_file_type () const

void	set_file_type (const StringPiece &value)

bool	has_kind () const

void	clear_kind ()

const StringPiece	get_kind () const

void	set_kind (const StringPiece &value)

bool	has_sql_export_options () const

void	clear_sql_export_options ()

const ExportContextSqlExportOptions	get_sql_export_options () const

ExportContextSqlExportOptions	mutable_sqlExportOptions ()

bool	has_uri () const

void	clear_uri ()

const StringPiece	get_uri () const

void	set_uri (const StringPiece &value)

Static Public Member Functions
static ExportContext *	New ()

Detailed Description

Database instance export context.

Constructor & Destructor Documentation

◆ ExportContext() [1/2]

google_sqladmin_api::ExportContext::ExportContext ( const Json::Value & storage )

explicit

Standard constructor for an immutable data object instance.

Parameters

[in] storage The underlying data storage for this instance.

◆ ExportContext() [2/2]

google_sqladmin_api::ExportContext::ExportContext ( Json::Value * storage )

explicit

Standard constructor for a mutable data object instance.

Parameters

[in] storage The underlying data storage for this instance.

◆ ~ExportContext()

google_sqladmin_api::ExportContext::~ExportContext ( )

virtual

Standard destructor.

Member Function Documentation

◆ clear_csv_export_options()

void google_sqladmin_api::ExportContext::clear_csv_export_options ( )

inline

Clears the 'csvExportOptions' attribute.

◆ clear_databases()

void google_sqladmin_api::ExportContext::clear_databases ( )

inline

Clears the 'databases' attribute.

◆ clear_file_type()

void google_sqladmin_api::ExportContext::clear_file_type ( )

inline

Clears the 'fileType' attribute.

◆ clear_kind()

void google_sqladmin_api::ExportContext::clear_kind ( )

inline

Clears the 'kind' attribute.

◆ clear_sql_export_options()

void google_sqladmin_api::ExportContext::clear_sql_export_options ( )

inline

Clears the 'sqlExportOptions' attribute.

◆ clear_uri()

void google_sqladmin_api::ExportContext::clear_uri ( )

inline

Clears the 'uri' attribute.

◆ get_csv_export_options()

const ExportContextCsvExportOptions google_sqladmin_api::ExportContext::get_csv_export_options ( ) const

inline

Get a reference to the value of the 'csvExportOptions' attribute.

◆ get_databases()

const client::JsonCppArray<string > google_sqladmin_api::ExportContext::get_databases ( ) const

inline

Get a reference to the value of the 'databases' attribute.

◆ get_file_type()

const StringPiece google_sqladmin_api::ExportContext::get_file_type ( ) const

inline

Get the value of the 'fileType' attribute.

◆ get_kind()

const StringPiece google_sqladmin_api::ExportContext::get_kind ( ) const

inline

Get the value of the 'kind' attribute.

◆ get_sql_export_options()

const ExportContextSqlExportOptions google_sqladmin_api::ExportContext::get_sql_export_options ( ) const

inline

Get a reference to the value of the 'sqlExportOptions' attribute.

◆ get_uri()

const StringPiece google_sqladmin_api::ExportContext::get_uri ( ) const

inline

Get the value of the 'uri' attribute.

◆ GetTypeName()

const StringPiece google_sqladmin_api::ExportContext::GetTypeName ( ) const

inline

Returns a string denoting the type of this data object.

Returns: google_sqladmin_api::ExportContext

◆ has_csv_export_options()

bool google_sqladmin_api::ExportContext::has_csv_export_options ( ) const

inline

Determine if the 'csvExportOptions' attribute was set.

Returns: true if the 'csvExportOptions' attribute was set.

◆ has_databases()

bool google_sqladmin_api::ExportContext::has_databases ( ) const

inline

Determine if the 'databases' attribute was set.

Returns: true if the 'databases' attribute was set.

◆ has_file_type()

bool google_sqladmin_api::ExportContext::has_file_type ( ) const

inline

Determine if the 'fileType' attribute was set.

Returns: true if the 'fileType' attribute was set.

◆ has_kind()

bool google_sqladmin_api::ExportContext::has_kind ( ) const

inline

Determine if the 'kind' attribute was set.

Returns: true if the 'kind' attribute was set.

◆ has_sql_export_options()

bool google_sqladmin_api::ExportContext::has_sql_export_options ( ) const

inline

Determine if the 'sqlExportOptions' attribute was set.

Returns: true if the 'sqlExportOptions' attribute was set.

◆ has_uri()

bool google_sqladmin_api::ExportContext::has_uri ( ) const

inline

Determine if the 'uri' attribute was set.

Returns: true if the 'uri' attribute was set.

◆ mutable_csvExportOptions()

ExportContextCsvExportOptions google_sqladmin_api::ExportContext::mutable_csvExportOptions ( )

inline

Gets a reference to a mutable value of the 'csvExportOptions' property.

Options for exporting data as CSV.

Returns: The result can be modified to change the attribute value.

◆ mutable_databases()

client::JsonCppArray<string > google_sqladmin_api::ExportContext::mutable_databases ( )

inline

Gets a reference to a mutable value of the 'databases' property.

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: Specify exactly one database to be exported. If fileType is CSV, this database must match the database used in the csvExportOptions.selectQuery property.

Returns: The result can be modified to change the attribute value.

◆ mutable_sqlExportOptions()

ExportContextSqlExportOptions google_sqladmin_api::ExportContext::mutable_sqlExportOptions ( )

inline

Gets a reference to a mutable value of the 'sqlExportOptions' property.

Options for exporting data as SQL statements.

Returns: The result can be modified to change the attribute value.

◆ New()

ExportContext * google_sqladmin_api::ExportContext::New ( )

static

Creates a new default instance.

Returns: Ownership is passed back to the caller.

◆ set_file_type()

void google_sqladmin_api::ExportContext::set_file_type ( const StringPiece & value )

inline

Change the 'fileType' attribute.

The file type for the specified uri.

SQL: The file contains SQL statements.
CSV: The file contains CSV data.

Parameters

[in] value The new value.

◆ set_kind()

void google_sqladmin_api::ExportContext::set_kind ( const StringPiece & value )

inline

Change the 'kind' attribute.

This is always sql::exportContext.

Parameters

[in] value The new value.

◆ set_uri()

void google_sqladmin_api::ExportContext::set_uri ( const StringPiece & value )

inline

Change the 'uri' attribute.

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 requests succeeds, but the operation fails. If fileType is SQL and the filename ends with .gz, the contents are compressed.

Parameters

[in] value The new value.

The documentation for this class was generated from the following files:

google/sqladmin_api/export_context.h
google/sqladmin_api/export_context.cc

Classes

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ ExportContext() [1/2]

◆ ExportContext() [2/2]

◆ ~ExportContext()

Member Function Documentation

◆ clear_csv_export_options()

◆ clear_databases()

◆ clear_file_type()

◆ clear_kind()

◆ clear_sql_export_options()

◆ clear_uri()

◆ get_csv_export_options()

◆ get_databases()

◆ get_file_type()

◆ get_kind()

◆ get_sql_export_options()

◆ get_uri()

◆ GetTypeName()

◆ has_csv_export_options()

◆ has_databases()

◆ has_file_type()

◆ has_kind()

◆ has_sql_export_options()

◆ has_uri()

◆ mutable_csvExportOptions()

◆ mutable_databases()

◆ mutable_sqlExportOptions()

◆ New()

◆ set_file_type()

◆ set_kind()

◆ set_uri()