Class: Google::Apis::SqladminV1beta4::ExportContext
- Inherits:
-
Object
- Object
- Google::Apis::SqladminV1beta4::ExportContext
- 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
-
#csv_export_options ⇒ Google::Apis::SqladminV1beta4::ExportContext::CsvExportOptions
Options for exporting data as CSV.
-
#databases ⇒ Array<String>
Databases to be exported.
-
#file_type ⇒ String
The file type for the specified uri.
-
#kind ⇒ String
This is always sql#exportContext.
-
#sql_export_options ⇒ Google::Apis::SqladminV1beta4::ExportContext::SqlExportOptions
Options for exporting data as SQL statements.
-
#uri ⇒ String
The path to the file in Google Cloud Storage where the export will be stored.
Instance Method Summary collapse
-
#initialize(**args) ⇒ ExportContext
constructor
A new instance of ExportContext.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Core::JsonObjectSupport
Methods included from Core::Hashable
Constructor Details
#initialize(**args) ⇒ ExportContext
Returns a new instance of ExportContext
917 918 919 |
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 917 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
877 878 879 |
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 877 def @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: Specify exactly one database to be exported. If fileType
is CSV, this database must match the database used in the csvExportOptions.
selectQuery property.
Corresponds to the JSON property databases
890 891 892 |
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 890 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
897 898 899 |
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 897 def file_type @file_type end |
#kind ⇒ String
This is always sql#exportContext.
Corresponds to the JSON property kind
902 903 904 |
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 902 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
907 908 909 |
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 907 def @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
915 916 917 |
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 915 def uri @uri end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
922 923 924 925 926 927 928 929 |
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 922 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 |