Class: Google::Cloud::AlloyDB::V1::ImportClusterRequest

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

Overview

Import cluster request.

Defined Under Namespace

Classes: CsvImportOptions, SqlImportOptions

Instance Attribute Summary collapse

Instance Attribute Details

#csv_import_options ⇒ ::Google::Cloud::AlloyDB::V1::ImportClusterRequest::CsvImportOptions

Returns Options for importing data in CSV format.

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

Returns:



313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
 
# File 'proto_docs/google/cloud/alloydb/v1/service.rb', line 313

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

  # Options for importing data in SQL format.
  class SqlImportOptions
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Options for importing data in CSV format.
  # @!attribute [rw] table
  #   @return [::String]
  #     Required. The database table to import CSV file into.
  # @!attribute [rw] columns
  #   @return [::Array<::String>]
  #     Optional. The columns to which CSV data is imported. If not specified,
  #     all columns of the database table are loaded with CSV 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 same as quote
  #     character. The value of this argument has to be a character in Hex ASCII
  #     Code.
  class CsvImportOptions
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#database ⇒ ::String

Returns Optional. Name of the database to which the import will be done. For import from SQL file, this is required only if the file does not specify a database. Note - Value provided should be the same as expected from SELECT current_database(); and NOT as a resource reference.

Returns:

  • (::String) —

    Optional. Name of the database to which the import will be done. For import from SQL file, this is required only if the file does not specify a database. Note - Value provided should be the same as expected from SELECT current_database(); and NOT as a resource reference.



313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
 
# File 'proto_docs/google/cloud/alloydb/v1/service.rb', line 313

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

  # Options for importing data in SQL format.
  class SqlImportOptions
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Options for importing data in CSV format.
  # @!attribute [rw] table
  #   @return [::String]
  #     Required. The database table to import CSV file into.
  # @!attribute [rw] columns
  #   @return [::Array<::String>]
  #     Optional. The columns to which CSV data is imported. If not specified,
  #     all columns of the database table are loaded with CSV 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 same as quote
  #     character. The value of this argument has to be a character in Hex ASCII
  #     Code.
  class CsvImportOptions
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#gcs_uri ⇒ ::String

Returns Required. The path to the file in Google Cloud Storage where the source file for import will be stored. The URI is in the form gs://bucketName/fileName.

Returns:

  • (::String) —

    Required. The path to the file in Google Cloud Storage where the source file for import will be stored. The URI is in the form gs://bucketName/fileName.



313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
 
# File 'proto_docs/google/cloud/alloydb/v1/service.rb', line 313

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

  # Options for importing data in SQL format.
  class SqlImportOptions
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Options for importing data in CSV format.
  # @!attribute [rw] table
  #   @return [::String]
  #     Required. The database table to import CSV file into.
  # @!attribute [rw] columns
  #   @return [::Array<::String>]
  #     Optional. The columns to which CSV data is imported. If not specified,
  #     all columns of the database table are loaded with CSV 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 same as quote
  #     character. The value of this argument has to be a character in Hex ASCII
  #     Code.
  class CsvImportOptions
    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.



313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
 
# File 'proto_docs/google/cloud/alloydb/v1/service.rb', line 313

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

  # Options for importing data in SQL format.
  class SqlImportOptions
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Options for importing data in CSV format.
  # @!attribute [rw] table
  #   @return [::String]
  #     Required. The database table to import CSV file into.
  # @!attribute [rw] columns
  #   @return [::Array<::String>]
  #     Optional. The columns to which CSV data is imported. If not specified,
  #     all columns of the database table are loaded with CSV 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 same as quote
  #     character. The value of this argument has to be a character in Hex ASCII
  #     Code.
  class CsvImportOptions
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#sql_import_options ⇒ ::Google::Cloud::AlloyDB::V1::ImportClusterRequest::SqlImportOptions

Returns Options for importing data in SQL format.

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

Returns:



313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
 
# File 'proto_docs/google/cloud/alloydb/v1/service.rb', line 313

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

  # Options for importing data in SQL format.
  class SqlImportOptions
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Options for importing data in CSV format.
  # @!attribute [rw] table
  #   @return [::String]
  #     Required. The database table to import CSV file into.
  # @!attribute [rw] columns
  #   @return [::Array<::String>]
  #     Optional. The columns to which CSV data is imported. If not specified,
  #     all columns of the database table are loaded with CSV 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 same as quote
  #     character. The value of this argument has to be a character in Hex ASCII
  #     Code.
  class CsvImportOptions
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#user ⇒ ::String

Returns Optional. Database user to be used for importing the data. Note - Value provided should be the same as expected from SELECT current_user; and NOT as a resource reference.

Returns:

  • (::String) —

    Optional. Database user to be used for importing the data. Note - Value provided should be the same as expected from SELECT current_user; and NOT as a resource reference.



313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
 
# File 'proto_docs/google/cloud/alloydb/v1/service.rb', line 313

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

  # Options for importing data in SQL format.
  class SqlImportOptions
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Options for importing data in CSV format.
  # @!attribute [rw] table
  #   @return [::String]
  #     Required. The database table to import CSV file into.
  # @!attribute [rw] columns
  #   @return [::Array<::String>]
  #     Optional. The columns to which CSV data is imported. If not specified,
  #     all columns of the database table are loaded with CSV 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 same as quote
  #     character. The value of this argument has to be a character in Hex ASCII
  #     Code.
  class CsvImportOptions
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end