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: BakExportOptions, CsvExportOptions, SqlExportOptions

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ ExportContext

Returns a new instance of ExportContext.



1466
1467
1468
 
# File 'lib/google/apis/sqladmin_v1beta4/classes.rb', line 1466

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

Instance Attribute Details

#bak_export_options ⇒ Google::Apis::SqladminV1beta4::ExportContext::BakExportOptions

Options for exporting BAK files (SQL Server-only) Corresponds to the JSON property bakExportOptions

Returns:



1417
1418
1419
 
# File 'lib/google/apis/sqladmin_v1beta4/classes.rb', line 1417

def bak_export_options
  @bak_export_options
end

#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:



1422
1423
1424
 
# File 'lib/google/apis/sqladmin_v1beta4/classes.rb', line 1422

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>) 


1435
1436
1437
 
# File 'lib/google/apis/sqladmin_v1beta4/classes.rb', line 1435

def databases
  @databases
end

#file_type ⇒ String

The file type for the specified uri. Corresponds to the JSON property fileType

Returns:

  • (String) 


1440
1441
1442
 
# File 'lib/google/apis/sqladmin_v1beta4/classes.rb', line 1440

def file_type
  @file_type
end

#kind ⇒ String

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

Returns:

  • (String) 


1445
1446
1447
 
# File 'lib/google/apis/sqladmin_v1beta4/classes.rb', line 1445

def kind
  @kind
end

#offload ⇒ Boolean Also known as: offload?

Option for export offload. Corresponds to the JSON property offload

Returns:

  • (Boolean) 


1450
1451
1452
 
# File 'lib/google/apis/sqladmin_v1beta4/classes.rb', line 1450

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:



1456
1457
1458
 
# File 'lib/google/apis/sqladmin_v1beta4/classes.rb', line 1456

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) 


1464
1465
1466
 
# File 'lib/google/apis/sqladmin_v1beta4/classes.rb', line 1464

def uri
  @uri
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
 
# File 'lib/google/apis/sqladmin_v1beta4/classes.rb', line 1471

def update!(**args)
  @bak_export_options = args[:bak_export_options] if args.key?(:bak_export_options)
  @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