Class: OCI::Opensearch::Models::OpensearchClusterBackup

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/opensearch/models/opensearch_cluster_backup.rb

Overview

An OpenSearch cluster backup resource. An cluster is set of instances that provide OpenSearch functionality in OCI Search Service with OpenSearch. For more information, see Cluster Backups.

Constant Summary collapse

BACKUP_TYPE_ENUM = 
[
  BACKUP_TYPE_SCHEDULED = 'SCHEDULED'.freeze,
  BACKUP_TYPE_MANUAL = 'MANUAL'.freeze,
  BACKUP_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_CREATING = 'CREATING'.freeze,
  LIFECYCLE_STATE_UPDATING = 'UPDATING'.freeze,
  LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze,
  LIFECYCLE_STATE_DELETING = 'DELETING'.freeze,
  LIFECYCLE_STATE_DELETED = 'DELETED'.freeze,
  LIFECYCLE_STATE_FAILED = 'FAILED'.freeze,
  LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ OpensearchClusterBackup

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

  • :backup_type (String) —

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

  • :lifecyle_details (String) —

    The value to assign to the #lifecyle_details property

  • :source_cluster_id (String) —

    The value to assign to the #source_cluster_id property

  • :namespace (String) —

    The value to assign to the #namespace property

  • :bucket_name (String) —

    The value to assign to the #bucket_name property

  • :prefix (String) —

    The value to assign to the #prefix property

  • :time_expired (DateTime) —

    The value to assign to the #time_expired property

  • :backup_size (Float) —

    The value to assign to the #backup_size property

  • :source_cluster_display_name (String) —

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



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
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
 
# File 'lib/oci/opensearch/models/opensearch_cluster_backup.rb', line 184

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

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

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

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

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

  self.time_expired = attributes[:'timeExpired'] if attributes[:'timeExpired']

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

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

  self.backup_size = attributes[:'backupSize'] if attributes[:'backupSize']

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

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

  self.source_cluster_display_name = attributes[:'sourceClusterDisplayName'] if attributes[:'sourceClusterDisplayName']

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

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

  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 ⇒ Float

The size in GB of the cluster backup.

Returns:

  • (Float) 


84
85
86
 
# File 'lib/oci/opensearch/models/opensearch_cluster_backup.rb', line 84

def backup_size
  @backup_size
end

#backup_type ⇒ String

[Required] Specifies whether the cluster backup was created manually, or automatically as a scheduled backup.

Returns:

  • (String) 


44
45
46
 
# File 'lib/oci/opensearch/models/opensearch_cluster_backup.rb', line 44

def backup_type
  @backup_type
end

#bucket_name ⇒ String

The name of the Object Storage bucket for the cluster backup.

Returns:

  • (String) 


72
73
74
 
# File 'lib/oci/opensearch/models/opensearch_cluster_backup.rb', line 72

def bucket_name
  @bucket_name
end

#compartment_id ⇒ String

[Required] The OCID of the compartment where the cluster backup is located.

Returns:

  • (String) 


40
41
42
 
# File 'lib/oci/opensearch/models/opensearch_cluster_backup.rb', line 40

def compartment_id
  @compartment_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>>) 


100
101
102
 
# File 'lib/oci/opensearch/models/opensearch_cluster_backup.rb', line 100

def defined_tags
  @defined_tags
end

#display_name ⇒ String

The name of the cluster backup. Avoid entering confidential information.

Returns:

  • (String) 


36
37
38
 
# File 'lib/oci/opensearch/models/opensearch_cluster_backup.rb', line 36

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>) 


94
95
96
 
# File 'lib/oci/opensearch/models/opensearch_cluster_backup.rb', line 94

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The OCID of the cluster backup.

Returns:

  • (String) 


32
33
34
 
# File 'lib/oci/opensearch/models/opensearch_cluster_backup.rb', line 32

def id
  @id
end

#lifecycle_state ⇒ String

[Required] The current state of the cluster backup.

Returns:

  • (String) 


56
57
58
 
# File 'lib/oci/opensearch/models/opensearch_cluster_backup.rb', line 56

def lifecycle_state
  @lifecycle_state
end

#lifecyle_details ⇒ String

Additional information about the current lifecycle state of the cluster backup.

Returns:

  • (String) 


60
61
62
 
# File 'lib/oci/opensearch/models/opensearch_cluster_backup.rb', line 60

def lifecyle_details
  @lifecyle_details
end

#namespace ⇒ String

The Object Storage namespace for the cluster backup.

Returns:

  • (String) 


68
69
70
 
# File 'lib/oci/opensearch/models/opensearch_cluster_backup.rb', line 68

def namespace
  @namespace
end

#prefix ⇒ String

The prefix within the Object Storage bucket for the cluster backup.

Returns:

  • (String) 


76
77
78
 
# File 'lib/oci/opensearch/models/opensearch_cluster_backup.rb', line 76

def prefix
  @prefix
end

#source_cluster_display_name ⇒ String

The name of the source OpenSearch cluster for the cluster backup.

Returns:

  • (String) 


88
89
90
 
# File 'lib/oci/opensearch/models/opensearch_cluster_backup.rb', line 88

def source_cluster_display_name
  @source_cluster_display_name
end

#source_cluster_id ⇒ String

[Required] The OCID of the source OpenSearch cluster for the cluster backup.

Returns:

  • (String) 


64
65
66
 
# File 'lib/oci/opensearch/models/opensearch_cluster_backup.rb', line 64

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>>) 


106
107
108
 
# File 'lib/oci/opensearch/models/opensearch_cluster_backup.rb', line 106

def system_tags
  @system_tags
end

#time_created ⇒ DateTime

The date and time the cluster backup was created. Format defined by RFC3339.

Returns:

  • (DateTime) 


48
49
50
 
# File 'lib/oci/opensearch/models/opensearch_cluster_backup.rb', line 48

def time_created
  @time_created
end

#time_expired ⇒ DateTime

The date and time the cluster backup expires. Format defined by RFC3339.

Returns:

  • (DateTime) 


80
81
82
 
# File 'lib/oci/opensearch/models/opensearch_cluster_backup.rb', line 80

def time_expired
  @time_expired
end

#time_updated ⇒ DateTime

The date and time the cluster backup was updated. Format defined by RFC3339.

Returns:

  • (DateTime) 


52
53
54
 
# File 'lib/oci/opensearch/models/opensearch_cluster_backup.rb', line 52

def time_updated
  @time_updated
end

Class Method Details

.attribute_map ⇒ Object

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



109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
 
# File 'lib/oci/opensearch/models/opensearch_cluster_backup.rb', line 109

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'display_name': :'displayName',
    'compartment_id': :'compartmentId',
    'backup_type': :'backupType',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'lifecycle_state': :'lifecycleState',
    'lifecyle_details': :'lifecyleDetails',
    'source_cluster_id': :'sourceClusterId',
    'namespace': :'namespace',
    'bucket_name': :'bucketName',
    'prefix': :'prefix',
    'time_expired': :'timeExpired',
    'backup_size': :'backupSize',
    'source_cluster_display_name': :'sourceClusterDisplayName',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'display_name': :'String',
    'compartment_id': :'String',
    'backup_type': :'String',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'lifecycle_state': :'String',
    'lifecyle_details': :'String',
    'source_cluster_id': :'String',
    'namespace': :'String',
    'bucket_name': :'String',
    'prefix': :'String',
    'time_expired': :'DateTime',
    'backup_size': :'Float',
    'source_cluster_display_name': :'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



320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
 
# File 'lib/oci/opensearch/models/opensearch_cluster_backup.rb', line 320

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

  self.class == other.class &&
    id == other.id &&
    display_name == other.display_name &&
    compartment_id == other.compartment_id &&
    backup_type == other.backup_type &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    lifecycle_state == other.lifecycle_state &&
    lifecyle_details == other.lifecyle_details &&
    source_cluster_id == other.source_cluster_id &&
    namespace == other.namespace &&
    bucket_name == other.bucket_name &&
    prefix == other.prefix &&
    time_expired == other.time_expired &&
    backup_size == other.backup_size &&
    source_cluster_display_name == other.source_cluster_display_name &&
    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



367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
 
# File 'lib/oci/opensearch/models/opensearch_cluster_backup.rb', line 367

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


347
348
349
 
# File 'lib/oci/opensearch/models/opensearch_cluster_backup.rb', line 347

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



356
357
358
 
# File 'lib/oci/opensearch/models/opensearch_cluster_backup.rb', line 356

def hash
  [id, display_name, compartment_id, backup_type, time_created, time_updated, lifecycle_state, lifecyle_details, source_cluster_id, namespace, bucket_name, prefix, time_expired, backup_size, source_cluster_display_name, 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



400
401
402
403
404
405
406
407
408
409
 
# File 'lib/oci/opensearch/models/opensearch_cluster_backup.rb', line 400

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



394
395
396
 
# File 'lib/oci/opensearch/models/opensearch_cluster_backup.rb', line 394

def to_s
  to_hash.to_s
end