Class: OCI::Mysql::Models::ExportBackupDetails

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

Overview

The parameters required to export a DB system backup.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ExportBackupDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'lib/oci/mysql/models/export_backup_details.rb', line 63

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.bucket_name = attributes[:'bucketName'] if attributes[:'bucketName']

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

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

  self.export_options = attributes[:'exportOptions'] if attributes[:'exportOptions']

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

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

  self.namespace_name = attributes[:'namespaceName'] if attributes[:'namespaceName']

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

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

  self.subnet_id = attributes[:'subnetId'] if attributes[:'subnetId']

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

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

Instance Attribute Details

#bucket_name ⇒ String

[Required] The Object Storage bucket name.

Returns:

  • (String) 


13
14
15
 
# File 'lib/oci/mysql/models/export_backup_details.rb', line 13

def bucket_name
  @bucket_name
end

#export_options ⇒ OCI::Mysql::Models::ExportOptions

Returns:



16
17
18
 
# File 'lib/oci/mysql/models/export_backup_details.rb', line 16

def export_options
  @export_options
end

#namespace_name ⇒ String

[Required] The Object Storage namespace.

Returns:

  • (String) 


20
21
22
 
# File 'lib/oci/mysql/models/export_backup_details.rb', line 20

def namespace_name
  @namespace_name
end

#subnet_id ⇒ String

The OCID of the subnet which the temporary MySQL instance is associated with. If not specified, the subnet OCID of the DB system from which the backup is taken will be used by default. To export a backup copied from another region, it is mandatory to specify a valid subnet OCID in the current region.

Returns:

  • (String) 


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

def subnet_id
  @subnet_id
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
39
 
# File 'lib/oci/mysql/models/export_backup_details.rb', line 30

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'bucket_name': :'bucketName',
    'export_options': :'exportOptions',
    'namespace_name': :'namespaceName',
    'subnet_id': :'subnetId'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'bucket_name': :'String',
    'export_options': :'OCI::Mysql::Models::ExportOptions',
    'namespace_name': :'String',
    'subnet_id': :'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



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

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

  self.class == other.class &&
    bucket_name == other.bucket_name &&
    export_options == other.export_options &&
    namespace_name == other.namespace_name &&
    subnet_id == other.subnet_id
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_backup_details.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_backup_details.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_backup_details.rb', line 123

def hash
  [bucket_name, export_options, namespace_name, subnet_id].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_backup_details.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_backup_details.rb', line 161

def to_s
  to_hash.to_s
end