Class: OCI::Opensearch::Models::OpensearchClusterBackupSummary

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

Overview

The summary of information about an OpenSearch cluster backup.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ OpensearchClusterBackupSummary

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

  • :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

  • :lifecycle_details (String) —

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



144
145
146
147
148
149
150
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
 
# File 'lib/oci/opensearch/models/opensearch_cluster_backup_summary.rb', line 144

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

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

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

  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) 


53
54
55
 
# File 'lib/oci/opensearch/models/opensearch_cluster_backup_summary.rb', line 53

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) 


25
26
27
 
# File 'lib/oci/opensearch/models/opensearch_cluster_backup_summary.rb', line 25

def backup_type
  @backup_type
end

#compartment_id ⇒ String

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

Returns:

  • (String) 


21
22
23
 
# File 'lib/oci/opensearch/models/opensearch_cluster_backup_summary.rb', line 21

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


69
70
71
 
# File 'lib/oci/opensearch/models/opensearch_cluster_backup_summary.rb', line 69

def defined_tags
  @defined_tags
end

#display_name ⇒ String

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

Returns:

  • (String) 


17
18
19
 
# File 'lib/oci/opensearch/models/opensearch_cluster_backup_summary.rb', line 17

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


63
64
65
 
# File 'lib/oci/opensearch/models/opensearch_cluster_backup_summary.rb', line 63

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The OCID of the cluster backup.

Returns:

  • (String) 


13
14
15
 
# File 'lib/oci/opensearch/models/opensearch_cluster_backup_summary.rb', line 13

def id
  @id
end

#lifecycle_details ⇒ String

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

Returns:

  • (String) 


45
46
47
 
# File 'lib/oci/opensearch/models/opensearch_cluster_backup_summary.rb', line 45

def lifecycle_details
  @lifecycle_details
end

#lifecycle_state ⇒ String

[Required] The current state of the cluster backup.

Returns:

  • (String) 


41
42
43
 
# File 'lib/oci/opensearch/models/opensearch_cluster_backup_summary.rb', line 41

def lifecycle_state
  @lifecycle_state
end

#source_cluster_display_name ⇒ String

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

Returns:

  • (String) 


57
58
59
 
# File 'lib/oci/opensearch/models/opensearch_cluster_backup_summary.rb', line 57

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) 


29
30
31
 
# File 'lib/oci/opensearch/models/opensearch_cluster_backup_summary.rb', line 29

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


75
76
77
 
# File 'lib/oci/opensearch/models/opensearch_cluster_backup_summary.rb', line 75

def system_tags
  @system_tags
end

#time_created ⇒ DateTime

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

Returns:

  • (DateTime) 


33
34
35
 
# File 'lib/oci/opensearch/models/opensearch_cluster_backup_summary.rb', line 33

def time_created
  @time_created
end

#time_expired ⇒ DateTime

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

Returns:

  • (DateTime) 


49
50
51
 
# File 'lib/oci/opensearch/models/opensearch_cluster_backup_summary.rb', line 49

def time_expired
  @time_expired
end

#time_updated ⇒ DateTime

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

Returns:

  • (DateTime) 


37
38
39
 
# File 'lib/oci/opensearch/models/opensearch_cluster_backup_summary.rb', line 37

def time_updated
  @time_updated
end

Class Method Details

.attribute_map ⇒ Object

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



78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'lib/oci/opensearch/models/opensearch_cluster_backup_summary.rb', line 78

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'display_name': :'displayName',
    'compartment_id': :'compartmentId',
    'backup_type': :'backupType',
    'source_cluster_id': :'sourceClusterId',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'lifecycle_state': :'lifecycleState',
    'lifecycle_details': :'lifecycleDetails',
    '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.



101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
 
# File 'lib/oci/opensearch/models/opensearch_cluster_backup_summary.rb', line 101

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'display_name': :'String',
    'compartment_id': :'String',
    'backup_type': :'String',
    'source_cluster_id': :'String',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'lifecycle_state': :'String',
    'lifecycle_details': :'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



244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
 
# File 'lib/oci/opensearch/models/opensearch_cluster_backup_summary.rb', line 244

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 &&
    source_cluster_id == other.source_cluster_id &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    lifecycle_state == other.lifecycle_state &&
    lifecycle_details == other.lifecycle_details &&
    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



288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
 
# File 'lib/oci/opensearch/models/opensearch_cluster_backup_summary.rb', line 288

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


268
269
270
 
# File 'lib/oci/opensearch/models/opensearch_cluster_backup_summary.rb', line 268

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



277
278
279
 
# File 'lib/oci/opensearch/models/opensearch_cluster_backup_summary.rb', line 277

def hash
  [id, display_name, compartment_id, backup_type, source_cluster_id, time_created, time_updated, lifecycle_state, lifecycle_details, 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



321
322
323
324
325
326
327
328
329
330
 
# File 'lib/oci/opensearch/models/opensearch_cluster_backup_summary.rb', line 321

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



315
316
317
 
# File 'lib/oci/opensearch/models/opensearch_cluster_backup_summary.rb', line 315

def to_s
  to_hash.to_s
end