Class: OCI::Redis::Models::OciCacheBackupSummary

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/redis/models/oci_cache_backup_summary.rb

Overview

Summary of the OCI Cache Backup.

Constant Summary collapse

BACKUP_TYPE_ENUM = 
[
  BACKUP_TYPE_MANUAL = 'MANUAL'.freeze,
  BACKUP_TYPE_AUTOMATED = 'AUTOMATED'.freeze,
  BACKUP_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ OciCacheBackupSummary

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :id (String) —

    The value to assign to the #id property

  • :display_name (String) —

    The value to assign to the #display_name property

  • :compartment_id (String) —

    The value to assign to the #compartment_id property

  • :source_cluster_id (String) —

    The value to assign to the #source_cluster_id property

  • :time_created (DateTime) —

    The value to assign to the #time_created property

  • :time_updated (DateTime) —

    The value to assign to the #time_updated property

  • :lifecycle_state (String) —

    The value to assign to the #lifecycle_state property

  • :cluster_mode (String) —

    The value to assign to the #cluster_mode property

  • :backup_source (String) —

    The value to assign to the #backup_source property

  • :retention_period_in_days (Integer) —

    The value to assign to the #retention_period_in_days property

  • :backup_size_in_gbs (Float) —

    The value to assign to the #backup_size_in_gbs property

  • :backup_type (String) —

    The value to assign to the #backup_type 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

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

    The value to assign to the #system_tags property



151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
 
# File 'lib/oci/redis/models/oci_cache_backup_summary.rb', line 151

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

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

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

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

  self.time_created = attributes[:'timeCreated'] if attributes[:'timeCreated']

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

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

  self.time_updated = attributes[:'timeUpdated'] if attributes[:'timeUpdated']

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

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

  self.lifecycle_state = attributes[:'lifecycleState'] if attributes[:'lifecycleState']

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

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

  self.cluster_mode = attributes[:'clusterMode'] if attributes[:'clusterMode']

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

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

  self.backup_source = attributes[:'backupSource'] if attributes[:'backupSource']
  self.backup_source = "REPLICA" if backup_source.nil? && !attributes.key?(:'backupSource') # rubocop:disable Style/StringLiterals

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

  self.backup_source = attributes[:'backup_source'] if attributes[:'backup_source']
  self.backup_source = "REPLICA" if backup_source.nil? && !attributes.key?(:'backupSource') && !attributes.key?(:'backup_source') # rubocop:disable Style/StringLiterals

  self.retention_period_in_days = attributes[:'retentionPeriodInDays'] if attributes[:'retentionPeriodInDays']

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

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

  self.backup_size_in_gbs = attributes[:'backupSizeInGBs'] if attributes[:'backupSizeInGBs']

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

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

  self.backup_type = attributes[:'backupType'] if attributes[:'backupType']

  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.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']

  self.system_tags = attributes[:'systemTags'] if attributes[:'systemTags']

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

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

Instance Attribute Details

#backup_size_in_gbs ⇒ Float

Backup size in GB.

Returns:

  • (Float) 


60
61
62
 
# File 'lib/oci/redis/models/oci_cache_backup_summary.rb', line 60

def backup_size_in_gbs
  @backup_size_in_gbs
end

#backup_source ⇒ String

Specifies whether the backup was created from a replica or primary node

Returns:

  • (String) 


52
53
54
 
# File 'lib/oci/redis/models/oci_cache_backup_summary.rb', line 52

def backup_source
  @backup_source
end

#backup_type ⇒ String

Backup Type.

Returns:

  • (String) 


64
65
66
 
# File 'lib/oci/redis/models/oci_cache_backup_summary.rb', line 64

def backup_type
  @backup_type
end

#cluster_mode ⇒ String

[Required] Specifies whether the cluster is sharded or non-sharded.

Returns:

  • (String) 


48
49
50
 
# File 'lib/oci/redis/models/oci_cache_backup_summary.rb', line 48

def cluster_mode
  @cluster_mode
end

#compartment_id ⇒ String

[Required] Compartment identifier

Returns:

  • (String) 


28
29
30
 
# File 'lib/oci/redis/models/oci_cache_backup_summary.rb', line 28

def compartment_id
  @compartment_id
end

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

[Required] 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>>) 


76
77
78
 
# File 'lib/oci/redis/models/oci_cache_backup_summary.rb', line 76

def defined_tags
  @defined_tags
end

#display_name ⇒ String

[Required] Backup identifier, can be renamed

Returns:

  • (String) 


24
25
26
 
# File 'lib/oci/redis/models/oci_cache_backup_summary.rb', line 24

def display_name
  @display_name
end

#freeform_tags ⇒ Hash<String, String>

[Required] 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>) 


70
71
72
 
# File 'lib/oci/redis/models/oci_cache_backup_summary.rb', line 70

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] Unique identifier that is immutable on creation

Returns:

  • (String) 


20
21
22
 
# File 'lib/oci/redis/models/oci_cache_backup_summary.rb', line 20

def id
  @id
end

#lifecycle_state ⇒ String

[Required] The current state of the backup.

Returns:

  • (String) 


44
45
46
 
# File 'lib/oci/redis/models/oci_cache_backup_summary.rb', line 44

def lifecycle_state
  @lifecycle_state
end

#retention_period_in_days ⇒ Integer

Backup retention period in days.

Returns:

  • (Integer) 


56
57
58
 
# File 'lib/oci/redis/models/oci_cache_backup_summary.rb', line 56

def retention_period_in_days
  @retention_period_in_days
end

#source_cluster_id ⇒ String

[Required] The source OCI Cache Cluster OCID.

Returns:

  • (String) 


32
33
34
 
# File 'lib/oci/redis/models/oci_cache_backup_summary.rb', line 32

def source_cluster_id
  @source_cluster_id
end

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

Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}

Returns:

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


82
83
84
 
# File 'lib/oci/redis/models/oci_cache_backup_summary.rb', line 82

def system_tags
  @system_tags
end

#time_created ⇒ DateTime

[Required] The date and time the backup was created. An RFC3339 formatted datetime string.

Returns:

  • (DateTime) 


36
37
38
 
# File 'lib/oci/redis/models/oci_cache_backup_summary.rb', line 36

def time_created
  @time_created
end

#time_updated ⇒ DateTime

The date and time the backup was updated. An RFC3339 formatted datetime string.

Returns:

  • (DateTime) 


40
41
42
 
# File 'lib/oci/redis/models/oci_cache_backup_summary.rb', line 40

def time_updated
  @time_updated
end

Class Method Details

.attribute_map ⇒ Object

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



85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/oci/redis/models/oci_cache_backup_summary.rb', line 85

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'display_name': :'displayName',
    'compartment_id': :'compartmentId',
    'source_cluster_id': :'sourceClusterId',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'lifecycle_state': :'lifecycleState',
    'cluster_mode': :'clusterMode',
    'backup_source': :'backupSource',
    'retention_period_in_days': :'retentionPeriodInDays',
    'backup_size_in_gbs': :'backupSizeInGBs',
    'backup_type': :'backupType',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
 
# File 'lib/oci/redis/models/oci_cache_backup_summary.rb', line 108

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'display_name': :'String',
    'compartment_id': :'String',
    'source_cluster_id': :'String',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'lifecycle_state': :'String',
    'cluster_mode': :'String',
    'backup_source': :'String',
    'retention_period_in_days': :'Integer',
    'backup_size_in_gbs': :'Float',
    'backup_type': :'String',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'system_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



266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
 
# File 'lib/oci/redis/models/oci_cache_backup_summary.rb', line 266

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

  self.class == other.class &&
    id == other.id &&
    display_name == other.display_name &&
    compartment_id == other.compartment_id &&
    source_cluster_id == other.source_cluster_id &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    lifecycle_state == other.lifecycle_state &&
    cluster_mode == other.cluster_mode &&
    backup_source == other.backup_source &&
    retention_period_in_days == other.retention_period_in_days &&
    backup_size_in_gbs == other.backup_size_in_gbs &&
    backup_type == other.backup_type &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    system_tags == other.system_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



310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
 
# File 'lib/oci/redis/models/oci_cache_backup_summary.rb', line 310

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


290
291
292
 
# File 'lib/oci/redis/models/oci_cache_backup_summary.rb', line 290

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



299
300
301
 
# File 'lib/oci/redis/models/oci_cache_backup_summary.rb', line 299

def hash
  [id, display_name, compartment_id, source_cluster_id, time_created, time_updated, lifecycle_state, cluster_mode, backup_source, retention_period_in_days, backup_size_in_gbs, backup_type, freeform_tags, defined_tags, system_tags].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



343
344
345
346
347
348
349
350
351
352
 
# File 'lib/oci/redis/models/oci_cache_backup_summary.rb', line 343

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



337
338
339
 
# File 'lib/oci/redis/models/oci_cache_backup_summary.rb', line 337

def to_s
  to_hash.to_s
end