Class: Google::Apis::SqladminV1beta4::ExportContext

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/sqladmin_v1beta4/classes.rb,
lib/google/apis/sqladmin_v1beta4/representations.rb,
lib/google/apis/sqladmin_v1beta4/representations.rb

Overview

Database instance export context.

Defined Under Namespace

Classes: CsvExportOptions, SqlExportOptions

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ ExportContext

Returns a new instance of ExportContext.



1146
1147
1148
 
# File 'lib/google/apis/sqladmin_v1beta4/classes.rb', line 1146

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#csv_export_options ⇒ Google::Apis::SqladminV1beta4::ExportContext::CsvExportOptions

Options for exporting data as CSV. MySQL and PostgreSQL instances only. Corresponds to the JSON property csvExportOptions

Returns:



1100
1101
1102
 
# File 'lib/google/apis/sqladmin_v1beta4/classes.rb', line 1100

def csv_export_options
  @csv_export_options
end

#databases ⇒ Array<String>

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. Corresponds to the JSON property databases

Returns:

  • (Array<String>) 


1113
1114
1115
 
# File 'lib/google/apis/sqladmin_v1beta4/classes.rb', line 1113

def databases
  @databases
end

#file_type ⇒ String

The file type for the specified uri. SQL: The file contains SQL statements. * CSV*: The file contains CSV data. BAK: The file contains backup data for a SQL Server instance. Corresponds to the JSON property fileType

Returns:

  • (String) 


1120
1121
1122
 
# File 'lib/google/apis/sqladmin_v1beta4/classes.rb', line 1120

def file_type
  @file_type
end

#kind ⇒ String

This is always sql#exportContext. Corresponds to the JSON property kind

Returns:

  • (String) 


1125
1126
1127
 
# File 'lib/google/apis/sqladmin_v1beta4/classes.rb', line 1125

def kind
  @kind
end

#offload ⇒ Boolean Also known as: offload?

Option for export offload. Corresponds to the JSON property offload

Returns:

  • (Boolean) 


1130
1131
1132
 
# File 'lib/google/apis/sqladmin_v1beta4/classes.rb', line 1130

def offload
  @offload
end

#sql_export_options ⇒ Google::Apis::SqladminV1beta4::ExportContext::SqlExportOptions

Options for exporting data as SQL statements. Corresponds to the JSON property sqlExportOptions

Returns:



1136
1137
1138
 
# File 'lib/google/apis/sqladmin_v1beta4/classes.rb', line 1136

def sql_export_options
  @sql_export_options
end

#uri ⇒ String

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. Corresponds to the JSON property uri

Returns:

  • (String) 


1144
1145
1146
 
# File 'lib/google/apis/sqladmin_v1beta4/classes.rb', line 1144

def uri
  @uri
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1151
1152
1153
1154
1155
1156
1157
1158
1159
 
# File 'lib/google/apis/sqladmin_v1beta4/classes.rb', line 1151

def update!(**args)
  @csv_export_options = args[:csv_export_options] if args.key?(:csv_export_options)
  @databases = args[:databases] if args.key?(:databases)
  @file_type = args[:file_type] if args.key?(:file_type)
  @kind = args[:kind] if args.key?(:kind)
  @offload = args[:offload] if args.key?(:offload)
  @sql_export_options = args[:sql_export_options] if args.key?(:sql_export_options)
  @uri = args[:uri] if args.key?(:uri)
end