Class: Google::Cloud::AlloyDB::V1::ExportClusterRequest

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/alloydb/v1/service.rb

Overview

Export cluster request.

Defined Under Namespace

Classes: CsvExportOptions, SqlExportOptions

Instance Attribute Summary collapse

Instance Attribute Details

#csv_export_options ⇒ ::Google::Cloud::AlloyDB::V1::ExportClusterRequest::CsvExportOptions

Returns Options for exporting data in CSV format. Required field to be set for CSV file type.

Note: The following fields are mutually exclusive: csv_export_options, sql_export_options. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::Google::Cloud::AlloyDB::V1::ExportClusterRequest::CsvExportOptions) —

    Options for exporting data in CSV format. Required field to be set for CSV file type.

    Note: The following fields are mutually exclusive: csv_export_options, sql_export_options. If a field in that set is populated, all other fields in the set will automatically be cleared.



223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
 
# File 'proto_docs/google/cloud/alloydb/v1/service.rb', line 223

class ExportClusterRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Options for exporting data in CSV format.
  # @!attribute [rw] select_query
  #   @return [::String]
  #     Required. The SELECT query used to extract the data.
  # @!attribute [rw] field_delimiter
  #   @return [::String]
  #     Optional. Specifies the character that separates columns within each row
  #     (line) of the file. The default is comma. The value of this argument has
  #     to be a character in Hex ASCII Code.
  # @!attribute [rw] quote_character
  #   @return [::String]
  #     Optional. Specifies the quoting character to be used when a data value is
  #     quoted. The default is double-quote. The value of this argument has to be
  #     a character in Hex ASCII Code.
  # @!attribute [rw] escape_character
  #   @return [::String]
  #     Optional. Specifies the character that should appear before a data
  #     character that needs to be escaped. The default is the same as quote
  #     character. The value of this argument has to be a character in Hex ASCII
  #     Code.
  class CsvExportOptions
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Options for exporting data in SQL format.
  # @!attribute [rw] tables
  #   @return [::Array<::String>]
  #     Optional. Tables to export from.
  # @!attribute [rw] schema_only
  #   @return [::Boolean]
  #     Optional. If true, only export the schema.
  # @!attribute [rw] clean_target_objects
  #   @return [::Boolean]
  #     Optional. If true, output commands to DROP all the dumped database
  #     objects prior to outputting the commands for creating them.
  # @!attribute [rw] if_exist_target_objects
  #   @return [::Boolean]
  #     Optional. If true, use DROP ... IF EXISTS commands to check for the
  #     object's existence before dropping it in clean_target_objects mode.
  class SqlExportOptions
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#database ⇒ ::String

Returns Required. Name of the database where the export command will be executed. Note - Value provided should be the same as expected from SELECT current_database(); and NOT as a resource reference.

Returns:

  • (::String) —

    Required. Name of the database where the export command will be executed. Note - Value provided should be the same as expected from SELECT current_database(); and NOT as a resource reference.



223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
 
# File 'proto_docs/google/cloud/alloydb/v1/service.rb', line 223

class ExportClusterRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Options for exporting data in CSV format.
  # @!attribute [rw] select_query
  #   @return [::String]
  #     Required. The SELECT query used to extract the data.
  # @!attribute [rw] field_delimiter
  #   @return [::String]
  #     Optional. Specifies the character that separates columns within each row
  #     (line) of the file. The default is comma. The value of this argument has
  #     to be a character in Hex ASCII Code.
  # @!attribute [rw] quote_character
  #   @return [::String]
  #     Optional. Specifies the quoting character to be used when a data value is
  #     quoted. The default is double-quote. The value of this argument has to be
  #     a character in Hex ASCII Code.
  # @!attribute [rw] escape_character
  #   @return [::String]
  #     Optional. Specifies the character that should appear before a data
  #     character that needs to be escaped. The default is the same as quote
  #     character. The value of this argument has to be a character in Hex ASCII
  #     Code.
  class CsvExportOptions
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Options for exporting data in SQL format.
  # @!attribute [rw] tables
  #   @return [::Array<::String>]
  #     Optional. Tables to export from.
  # @!attribute [rw] schema_only
  #   @return [::Boolean]
  #     Optional. If true, only export the schema.
  # @!attribute [rw] clean_target_objects
  #   @return [::Boolean]
  #     Optional. If true, output commands to DROP all the dumped database
  #     objects prior to outputting the commands for creating them.
  # @!attribute [rw] if_exist_target_objects
  #   @return [::Boolean]
  #     Optional. If true, use DROP ... IF EXISTS commands to check for the
  #     object's existence before dropping it in clean_target_objects mode.
  class SqlExportOptions
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#gcs_destination ⇒ ::Google::Cloud::AlloyDB::V1::GcsDestination

Returns Required. Option to export data to cloud storage.

Returns:



223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
 
# File 'proto_docs/google/cloud/alloydb/v1/service.rb', line 223

class ExportClusterRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Options for exporting data in CSV format.
  # @!attribute [rw] select_query
  #   @return [::String]
  #     Required. The SELECT query used to extract the data.
  # @!attribute [rw] field_delimiter
  #   @return [::String]
  #     Optional. Specifies the character that separates columns within each row
  #     (line) of the file. The default is comma. The value of this argument has
  #     to be a character in Hex ASCII Code.
  # @!attribute [rw] quote_character
  #   @return [::String]
  #     Optional. Specifies the quoting character to be used when a data value is
  #     quoted. The default is double-quote. The value of this argument has to be
  #     a character in Hex ASCII Code.
  # @!attribute [rw] escape_character
  #   @return [::String]
  #     Optional. Specifies the character that should appear before a data
  #     character that needs to be escaped. The default is the same as quote
  #     character. The value of this argument has to be a character in Hex ASCII
  #     Code.
  class CsvExportOptions
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Options for exporting data in SQL format.
  # @!attribute [rw] tables
  #   @return [::Array<::String>]
  #     Optional. Tables to export from.
  # @!attribute [rw] schema_only
  #   @return [::Boolean]
  #     Optional. If true, only export the schema.
  # @!attribute [rw] clean_target_objects
  #   @return [::Boolean]
  #     Optional. If true, output commands to DROP all the dumped database
  #     objects prior to outputting the commands for creating them.
  # @!attribute [rw] if_exist_target_objects
  #   @return [::Boolean]
  #     Optional. If true, use DROP ... IF EXISTS commands to check for the
  #     object's existence before dropping it in clean_target_objects mode.
  class SqlExportOptions
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#name ⇒ ::String

Returns Required. The resource name of the cluster.

Returns:

  • (::String) —

    Required. The resource name of the cluster.



223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
 
# File 'proto_docs/google/cloud/alloydb/v1/service.rb', line 223

class ExportClusterRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Options for exporting data in CSV format.
  # @!attribute [rw] select_query
  #   @return [::String]
  #     Required. The SELECT query used to extract the data.
  # @!attribute [rw] field_delimiter
  #   @return [::String]
  #     Optional. Specifies the character that separates columns within each row
  #     (line) of the file. The default is comma. The value of this argument has
  #     to be a character in Hex ASCII Code.
  # @!attribute [rw] quote_character
  #   @return [::String]
  #     Optional. Specifies the quoting character to be used when a data value is
  #     quoted. The default is double-quote. The value of this argument has to be
  #     a character in Hex ASCII Code.
  # @!attribute [rw] escape_character
  #   @return [::String]
  #     Optional. Specifies the character that should appear before a data
  #     character that needs to be escaped. The default is the same as quote
  #     character. The value of this argument has to be a character in Hex ASCII
  #     Code.
  class CsvExportOptions
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Options for exporting data in SQL format.
  # @!attribute [rw] tables
  #   @return [::Array<::String>]
  #     Optional. Tables to export from.
  # @!attribute [rw] schema_only
  #   @return [::Boolean]
  #     Optional. If true, only export the schema.
  # @!attribute [rw] clean_target_objects
  #   @return [::Boolean]
  #     Optional. If true, output commands to DROP all the dumped database
  #     objects prior to outputting the commands for creating them.
  # @!attribute [rw] if_exist_target_objects
  #   @return [::Boolean]
  #     Optional. If true, use DROP ... IF EXISTS commands to check for the
  #     object's existence before dropping it in clean_target_objects mode.
  class SqlExportOptions
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#sql_export_options ⇒ ::Google::Cloud::AlloyDB::V1::ExportClusterRequest::SqlExportOptions

Returns Options for exporting data in SQL format. Required field to be set for SQL file type.

Note: The following fields are mutually exclusive: sql_export_options, csv_export_options. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::Google::Cloud::AlloyDB::V1::ExportClusterRequest::SqlExportOptions) —

    Options for exporting data in SQL format. Required field to be set for SQL file type.

    Note: The following fields are mutually exclusive: sql_export_options, csv_export_options. If a field in that set is populated, all other fields in the set will automatically be cleared.



223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
 
# File 'proto_docs/google/cloud/alloydb/v1/service.rb', line 223

class ExportClusterRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Options for exporting data in CSV format.
  # @!attribute [rw] select_query
  #   @return [::String]
  #     Required. The SELECT query used to extract the data.
  # @!attribute [rw] field_delimiter
  #   @return [::String]
  #     Optional. Specifies the character that separates columns within each row
  #     (line) of the file. The default is comma. The value of this argument has
  #     to be a character in Hex ASCII Code.
  # @!attribute [rw] quote_character
  #   @return [::String]
  #     Optional. Specifies the quoting character to be used when a data value is
  #     quoted. The default is double-quote. The value of this argument has to be
  #     a character in Hex ASCII Code.
  # @!attribute [rw] escape_character
  #   @return [::String]
  #     Optional. Specifies the character that should appear before a data
  #     character that needs to be escaped. The default is the same as quote
  #     character. The value of this argument has to be a character in Hex ASCII
  #     Code.
  class CsvExportOptions
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Options for exporting data in SQL format.
  # @!attribute [rw] tables
  #   @return [::Array<::String>]
  #     Optional. Tables to export from.
  # @!attribute [rw] schema_only
  #   @return [::Boolean]
  #     Optional. If true, only export the schema.
  # @!attribute [rw] clean_target_objects
  #   @return [::Boolean]
  #     Optional. If true, output commands to DROP all the dumped database
  #     objects prior to outputting the commands for creating them.
  # @!attribute [rw] if_exist_target_objects
  #   @return [::Boolean]
  #     Optional. If true, use DROP ... IF EXISTS commands to check for the
  #     object's existence before dropping it in clean_target_objects mode.
  class SqlExportOptions
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end