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

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/sqladmin_v1beta4/classes.rb,
generated/google/apis/sqladmin_v1beta4/representations.rb,
generated/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

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ ExportContext

Returns a new instance of ExportContext



797
798
799
 
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 797

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

Instance Attribute Details

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

Options for exporting data as CSV. Corresponds to the JSON property csvExportOptions

Returns:



761
762
763
 
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 761

def csv_export_options
  @csv_export_options
end

#databases ⇒ Array<String>

Databases (for example, guestbook) from which the export is made. If fileType is SQL and no database is specified, all databases are exported. If fileType is CSV, you can optionally specify at most one database to export. If csvExportOptions.selectQuery also specifies the database, this field will be ignored. Corresponds to the JSON property databases

Returns:

  • (Array<String>) 


770
771
772
 
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 770

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

Returns:

  • (String) 


777
778
779
 
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 777

def file_type
  @file_type
end

#kind ⇒ String

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

Returns:

  • (String) 


782
783
784
 
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 782

def kind
  @kind
end

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

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

Returns:



787
788
789
 
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 787

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


795
796
797
 
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 795

def uri
  @uri
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



802
803
804
805
806
807
808
809
 
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 802

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)
  @sql_export_options = args[:sql_export_options] if args.key?(:sql_export_options)
  @uri = args[:uri] if args.key?(:uri)
end