Class: OCI::Mysql::Models::ExportOptions

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/mysql/models/export_options.rb

Overview

The additional options used while exporting the DB system backup.

Constant Summary collapse

DATA_FORMAT_ENUM = 
[
  DATA_FORMAT_CSV = 'CSV'.freeze,
  DATA_FORMAT_TSV = 'TSV'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ExportOptions

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash

Options Hash (attributes):



60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
 
# File 'lib/oci/mysql/models/export_options.rb', line 60

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  self.compression_options = attributes[:'compressionOptions'] if attributes[:'compressionOptions']

  raise 'You cannot provide both :compressionOptions and :compression_options' if attributes.key?(:'compressionOptions') && attributes.key?(:'compression_options')

  self.compression_options = attributes[:'compression_options'] if attributes[:'compression_options']

  self.data_format = attributes[:'dataFormat'] if attributes[:'dataFormat']
  self.data_format = "CSV" if data_format.nil? && !attributes.key?(:'dataFormat') # rubocop:disable Style/StringLiterals

  raise 'You cannot provide both :dataFormat and :data_format' if attributes.key?(:'dataFormat') && attributes.key?(:'data_format')

  self.data_format = attributes[:'data_format'] if attributes[:'data_format']
  self.data_format = "CSV" if data_format.nil? && !attributes.key?(:'dataFormat') && !attributes.key?(:'data_format') # rubocop:disable Style/StringLiterals

  self.folder_name = attributes[:'folderName'] if attributes[:'folderName']

  raise 'You cannot provide both :folderName and :folder_name' if attributes.key?(:'folderName') && attributes.key?(:'folder_name')

  self.folder_name = attributes[:'folder_name'] if attributes[:'folder_name']
end

Instance Attribute Details

#compression_options ⇒ OCI::Mysql::Models::CompressionOptions

Returns:



17
18
19
 
# File 'lib/oci/mysql/models/export_options.rb', line 17

def compression_options
  @compression_options
end

#data_format ⇒ String

The format used for storing data.

Returns:

  • (String) 


21
22
23
 
# File 'lib/oci/mysql/models/export_options.rb', line 21

def data_format
  @data_format
end

#folder_name ⇒ String

The name of the folder in the Object Storage bucket where the dump files will be stored. A folder with the same name must not exist in the bucket. The folder will be created in the export process.

Returns:

  • (String) 


27
28
29
 
# File 'lib/oci/mysql/models/export_options.rb', line 27

def folder_name
  @folder_name
end

Class Method Details

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



30
31
32
33
34
35
36
37
38
 
# File 'lib/oci/mysql/models/export_options.rb', line 30

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'compression_options': :'compressionOptions',
    'data_format': :'dataFormat',
    'folder_name': :'folderName'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



41
42
43
44
45
46
47
48
49
 
# File 'lib/oci/mysql/models/export_options.rb', line 41

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'compression_options': :'OCI::Mysql::Models::CompressionOptions',
    'data_format': :'String',
    'folder_name': :'String'
    # rubocop:enable Style/SymbolLiteral
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other (Object) —

    the other object to be compared



102
103
104
105
106
107
108
109
 
# File 'lib/oci/mysql/models/export_options.rb', line 102

def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    compression_options == other.compression_options &&
    data_format == other.data_format &&
    folder_name == other.folder_name
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
 
# File 'lib/oci/mysql/models/export_options.rb', line 134

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)

  self.class.swagger_types.each_pair do |key, type|
    if type =~ /^Array<(.*)>/i
      # check to ensure the input is an array given that the the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        public_method("#{key}=").call(
          attributes[self.class.attribute_map[key]]
            .map { |v| OCI::Internal::Util.convert_to_type(Regexp.last_match(1), v) }
        )
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      public_method("#{key}=").call(
        OCI::Internal::Util.convert_to_type(type, attributes[self.class.attribute_map[key]])
      )
    end
    # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(other) ⇒ Boolean

Parameters:

  • other (Object) —

    the other object to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


114
115
116
 
# File 'lib/oci/mysql/models/export_options.rb', line 114

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



123
124
125
 
# File 'lib/oci/mysql/models/export_options.rb', line 123

def hash
  [compression_options, data_format, folder_name].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



167
168
169
170
171
172
173
174
175
176
 
# File 'lib/oci/mysql/models/export_options.rb', line 167

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = public_method(attr).call
    next if value.nil? && !instance_variable_defined?("@#{attr}")

    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



161
162
163
 
# File 'lib/oci/mysql/models/export_options.rb', line 161

def to_s
  to_hash.to_s
end