Class: Google::Cloud::AlloyDB::V1alpha::ExportClusterRequest

Inherits:

Object

• Object
• Google::Cloud::AlloyDB::V1alpha::ExportClusterRequest

Extended by:

Protobuf::MessageExts::ClassMethods

Includes:

Protobuf::MessageExts

Defined in:

proto_docs/google/cloud/alloydb/v1alpha/service.rb

Overview

Export cluster request.

Defined Under Namespace

Classes: CsvExportOptions, SqlExportOptions

Instance Attribute Summary

• #csv_export_options ⇒ ::Google::Cloud::AlloyDB::V1alpha::ExportClusterRequest::CsvExportOptions

  Options for exporting data in CSV format.

• #database ⇒ ::String

  Required.

• #gcs_destination ⇒ ::Google::Cloud::AlloyDB::V1alpha::GcsDestination

  Required.

• #name ⇒ ::String

  Required.

• #sql_export_options ⇒ ::Google::Cloud::AlloyDB::V1alpha::ExportClusterRequest::SqlExportOptions

  Options for exporting data in SQL format.

Instance Attribute Details

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

# File 'proto_docs/google/cloud/alloydb/v1alpha/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

# File 'proto_docs/google/cloud/alloydb/v1alpha/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::V1alpha::GcsDestination

# File 'proto_docs/google/cloud/alloydb/v1alpha/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

# File 'proto_docs/google/cloud/alloydb/v1alpha/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::V1alpha::ExportClusterRequest::SqlExportOptions

# File 'proto_docs/google/cloud/alloydb/v1alpha/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