Class: OCI::Mysql::Models::CopyBackupDetails

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

Overview

Details required to copy a DB system backup from its source region to a destination region.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CopyBackupDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :compartment_id (String) —

    The value to assign to the #compartment_id property

  • :description (String) —

    The value to assign to the #description property

  • :display_name (String) —

    The value to assign to the #display_name property

  • :backup_copy_retention_in_days (Integer) —

    The value to assign to the #backup_copy_retention_in_days property

  • :source_backup_id (String) —

    The value to assign to the #source_backup_id property

  • :source_region (String) —

    The value to assign to the #source_region property



88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
 
# File 'lib/oci/mysql/models/copy_backup_details.rb', line 88

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

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

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

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

  self.display_name = attributes[:'displayName'] if attributes[:'displayName']

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

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

  self.backup_copy_retention_in_days = attributes[:'backupCopyRetentionInDays'] if attributes[:'backupCopyRetentionInDays']

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

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

  self.source_backup_id = attributes[:'sourceBackupId'] if attributes[:'sourceBackupId']

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

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

  self.source_region = attributes[:'sourceRegion'] if attributes[:'sourceRegion']

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

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

Instance Attribute Details

#backup_copy_retention_in_days ⇒ Integer

Number of days to retain the copied DB system backup.

Note: The maximum value for an automatic backup is 35, and the maximum value for a manual backup is 365.

Returns:

  • (Integer) 


35
36
37
 
# File 'lib/oci/mysql/models/copy_backup_details.rb', line 35

def backup_copy_retention_in_days
  @backup_copy_retention_in_days
end

#compartment_id ⇒ String

[Required] The OCID of the compartment the DB system backup is to be copied to.

Note: The compartment must be the same as the compartment of the DB system backup in the source region.

Returns:

  • (String) 


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

def compartment_id
  @compartment_id
end

#description ⇒ String

A user-supplied description for the DB system backup. By default, the source backup description will be used.

Returns:

  • (String) 


22
23
24
 
# File 'lib/oci/mysql/models/copy_backup_details.rb', line 22

def description
  @description
end

#display_name ⇒ String

A user-supplied display name for the DB system backup. By default, the source backup display name will be used.

Returns:

  • (String) 


28
29
30
 
# File 'lib/oci/mysql/models/copy_backup_details.rb', line 28

def display_name
  @display_name
end

#source_backup_id ⇒ String

[Required] The OCID of DB system backup to be copied.

Returns:

  • (String) 


40
41
42
 
# File 'lib/oci/mysql/models/copy_backup_details.rb', line 40

def source_backup_id
  @source_backup_id
end

#source_region ⇒ String

[Required] The region identifier of the source region where the DB system backup exists. For more information, please see Regions and Availability Domains.

Returns:

  • (String) 


46
47
48
 
# File 'lib/oci/mysql/models/copy_backup_details.rb', line 46

def source_region
  @source_region
end

Class Method Details

.attribute_map ⇒ Object

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



49
50
51
52
53
54
55
56
57
58
59
60
 
# File 'lib/oci/mysql/models/copy_backup_details.rb', line 49

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'compartment_id': :'compartmentId',
    'description': :'description',
    'display_name': :'displayName',
    'backup_copy_retention_in_days': :'backupCopyRetentionInDays',
    'source_backup_id': :'sourceBackupId',
    'source_region': :'sourceRegion'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/oci/mysql/models/copy_backup_details.rb', line 63

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'compartment_id': :'String',
    'description': :'String',
    'display_name': :'String',
    'backup_copy_retention_in_days': :'Integer',
    'source_backup_id': :'String',
    'source_region': :'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



134
135
136
137
138
139
140
141
142
143
144
 
# File 'lib/oci/mysql/models/copy_backup_details.rb', line 134

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

  self.class == other.class &&
    compartment_id == other.compartment_id &&
    description == other.description &&
    display_name == other.display_name &&
    backup_copy_retention_in_days == other.backup_copy_retention_in_days &&
    source_backup_id == other.source_backup_id &&
    source_region == other.source_region
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



169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
 
# File 'lib/oci/mysql/models/copy_backup_details.rb', line 169

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


149
150
151
 
# File 'lib/oci/mysql/models/copy_backup_details.rb', line 149

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



158
159
160
 
# File 'lib/oci/mysql/models/copy_backup_details.rb', line 158

def hash
  [compartment_id, description, display_name, backup_copy_retention_in_days, source_backup_id, source_region].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



202
203
204
205
206
207
208
209
210
211
 
# File 'lib/oci/mysql/models/copy_backup_details.rb', line 202

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



196
197
198
 
# File 'lib/oci/mysql/models/copy_backup_details.rb', line 196

def to_s
  to_hash.to_s
end