Class: OCI::Mysql::Models::CreateBackupDetails

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

Overview

Complete information for a Backup.

Constant Summary collapse

SOFT_DELETE_ENUM = 
[
  SOFT_DELETE_ENABLED = 'ENABLED'.freeze,
  SOFT_DELETE_DISABLED = 'DISABLED'.freeze
].freeze
BACKUP_TYPE_ENUM = 
[
  BACKUP_TYPE_FULL = 'FULL'.freeze,
  BACKUP_TYPE_INCREMENTAL = 'INCREMENTAL'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateBackupDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :display_name (String) —

    The value to assign to the #display_name property

  • :description (String) —

    The value to assign to the #description property

  • :soft_delete (String) —

    The value to assign to the #soft_delete property

  • :backup_type (String) —

    The value to assign to the #backup_type property

  • :db_system_id (String) —

    The value to assign to the #db_system_id property

  • :retention_in_days (Integer) —

    The value to assign to the #retention_in_days property

  • :freeform_tags (Hash<String, String>) —

    The value to assign to the #freeform_tags property

  • :defined_tags (Hash<String, Hash<String, Object>>) —

    The value to assign to the #defined_tags property



105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
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/create_backup_details.rb', line 105

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

  self.soft_delete = attributes[:'softDelete'] if attributes[:'softDelete']

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

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

  self.backup_type = attributes[:'backupType'] if attributes[:'backupType']
  self.backup_type = "INCREMENTAL" if backup_type.nil? && !attributes.key?(:'backupType') # rubocop:disable Style/StringLiterals

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

  self.backup_type = attributes[:'backup_type'] if attributes[:'backup_type']
  self.backup_type = "INCREMENTAL" if backup_type.nil? && !attributes.key?(:'backupType') && !attributes.key?(:'backup_type') # rubocop:disable Style/StringLiterals

  self.db_system_id = attributes[:'dbSystemId'] if attributes[:'dbSystemId']

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

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

  self.retention_in_days = attributes[:'retentionInDays'] if attributes[:'retentionInDays']

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

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

  self.freeform_tags = attributes[:'freeformTags'] if attributes[:'freeformTags']

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

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

  self.defined_tags = attributes[:'definedTags'] if attributes[:'definedTags']

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

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

Instance Attribute Details

#backup_type ⇒ String

The type of backup.

Returns:

  • (String) 


37
38
39
 
# File 'lib/oci/mysql/models/create_backup_details.rb', line 37

def backup_type
  @backup_type
end

#db_system_id ⇒ String

[Required] The OCID of the DB System the Backup is associated with.

Returns:

  • (String) 


41
42
43
 
# File 'lib/oci/mysql/models/create_backup_details.rb', line 41

def db_system_id
  @db_system_id
end

#defined_tags ⇒ Hash<String, Hash<String, Object>>

Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {\"foo-namespace\": {\"bar-key\": \"value\"}}

Returns:

  • (Hash<String, Hash<String, Object>>) 


57
58
59
 
# File 'lib/oci/mysql/models/create_backup_details.rb', line 57

def defined_tags
  @defined_tags
end

#description ⇒ String

A user-supplied description for the backup.

Returns:

  • (String) 


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

def description
  @description
end

#display_name ⇒ String

A user-supplied display name for the backup.

Returns:

  • (String) 


23
24
25
 
# File 'lib/oci/mysql/models/create_backup_details.rb', line 23

def display_name
  @display_name
end

#freeform_tags ⇒ Hash<String, String>

Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {\"bar-key\": \"value\"}

Returns:

  • (Hash<String, String>) 


51
52
53
 
# File 'lib/oci/mysql/models/create_backup_details.rb', line 51

def freeform_tags
  @freeform_tags
end

#retention_in_days ⇒ Integer

Number of days to retain this backup.

Returns:

  • (Integer) 


45
46
47
 
# File 'lib/oci/mysql/models/create_backup_details.rb', line 45

def retention_in_days
  @retention_in_days
end

#soft_delete ⇒ String

Retains the backup to be deleted due to the retention policy in DELETE SCHEDULED state for 7 days before permanently deleting it.

Returns:

  • (String) 


33
34
35
 
# File 'lib/oci/mysql/models/create_backup_details.rb', line 33

def soft_delete
  @soft_delete
end

Class Method Details

.attribute_map ⇒ Object

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



60
61
62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/oci/mysql/models/create_backup_details.rb', line 60

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'display_name': :'displayName',
    'description': :'description',
    'soft_delete': :'softDelete',
    'backup_type': :'backupType',
    'db_system_id': :'dbSystemId',
    'retention_in_days': :'retentionInDays',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/oci/mysql/models/create_backup_details.rb', line 76

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'display_name': :'String',
    'description': :'String',
    'soft_delete': :'String',
    'backup_type': :'String',
    'db_system_id': :'String',
    'retention_in_days': :'Integer',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>'
    # 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



181
182
183
184
185
186
187
188
189
190
191
192
193
 
# File 'lib/oci/mysql/models/create_backup_details.rb', line 181

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

  self.class == other.class &&
    display_name == other.display_name &&
    description == other.description &&
    soft_delete == other.soft_delete &&
    backup_type == other.backup_type &&
    db_system_id == other.db_system_id &&
    retention_in_days == other.retention_in_days &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags
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



218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
 
# File 'lib/oci/mysql/models/create_backup_details.rb', line 218

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


198
199
200
 
# File 'lib/oci/mysql/models/create_backup_details.rb', line 198

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



207
208
209
 
# File 'lib/oci/mysql/models/create_backup_details.rb', line 207

def hash
  [display_name, description, soft_delete, backup_type, db_system_id, retention_in_days, freeform_tags, defined_tags].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



251
252
253
254
255
256
257
258
259
260
 
# File 'lib/oci/mysql/models/create_backup_details.rb', line 251

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



245
246
247
 
# File 'lib/oci/mysql/models/create_backup_details.rb', line 245

def to_s
  to_hash.to_s
end