Class: OCI::Opensearch::Models::OpensearchClusterSummary

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

Overview

The summary of information about an OpenSearch cluster.

Constant Summary collapse

SECURITY_MODE_ENUM = 
[
  SECURITY_MODE_DISABLED = 'DISABLED'.freeze,
  SECURITY_MODE_PERMISSIVE = 'PERMISSIVE'.freeze,
  SECURITY_MODE_ENFORCING = 'ENFORCING'.freeze,
  SECURITY_MODE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ OpensearchClusterSummary

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
245
246
247
248
249
250
251
252
253
254
255
256
257
258
 
# File 'lib/oci/opensearch/models/opensearch_cluster_summary.rb', line 161

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

  self.software_version = attributes[:'softwareVersion'] if attributes[:'softwareVersion']

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

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

  self.total_storage_gb = attributes[:'totalStorageGB'] if attributes[:'totalStorageGB']

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

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

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

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

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

  self.security_mode = attributes[:'securityMode'] if attributes[:'securityMode']

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

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

  self.backup_policy = attributes[:'backupPolicy'] if attributes[:'backupPolicy']

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

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

  self.outbound_cluster_config = attributes[:'outboundClusterConfig'] if attributes[:'outboundClusterConfig']

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

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

Instance Attribute Details

#availability_domains ⇒ Array<String>

The availability domains to distribute the cluser nodes across.

Returns:

  • (Array<String>) 


79
80
81
 
# File 'lib/oci/opensearch/models/opensearch_cluster_summary.rb', line 79

def availability_domains
  @availability_domains
end

#backup_policy ⇒ OCI::Opensearch::Models::BackupPolicy

Returns:



86
87
88
 
# File 'lib/oci/opensearch/models/opensearch_cluster_summary.rb', line 86

def backup_policy
  @backup_policy
end

#compartment_id ⇒ String

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

Returns:

  • (String) 


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

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


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

def defined_tags
  @defined_tags
end

#display_name ⇒ String

The name of the cluster. Avoid entering confidential information.

Returns:

  • (String) 


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

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/opensearch/models/opensearch_cluster_summary.rb', line 51

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The OCID of the cluster.

Returns:

  • (String) 


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

def id
  @id
end

#lifecycle_details ⇒ String

Additional information about the current lifecycle state of the cluster.

Returns:

  • (String) 


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

def lifecycle_details
  @lifecycle_details
end

#lifecycle_state ⇒ String

The current state of the cluster.

Returns:

  • (String) 


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

def lifecycle_state
  @lifecycle_state
end

#outbound_cluster_config ⇒ OCI::Opensearch::Models::OutboundClusterConfig

Returns:



89
90
91
 
# File 'lib/oci/opensearch/models/opensearch_cluster_summary.rb', line 89

def outbound_cluster_config
  @outbound_cluster_config
end

#security_mode ⇒ String

The security mode of the cluster.

Returns:

  • (String) 


83
84
85
 
# File 'lib/oci/opensearch/models/opensearch_cluster_summary.rb', line 83

def security_mode
  @security_mode
end

#software_version ⇒ String

[Required] The software version the cluster is running.

Returns:

  • (String) 


67
68
69
 
# File 'lib/oci/opensearch/models/opensearch_cluster_summary.rb', line 67

def software_version
  @software_version
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>>) 


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

def system_tags
  @system_tags
end

#time_created ⇒ DateTime

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

Returns:

  • (DateTime) 


35
36
37
 
# File 'lib/oci/opensearch/models/opensearch_cluster_summary.rb', line 35

def time_created
  @time_created
end

#time_updated ⇒ DateTime

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

Returns:

  • (DateTime) 


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

def time_updated
  @time_updated
end

#total_storage_gb ⇒ Integer

[Required] The total amount of storage in GB, for the cluster.

Returns:

  • (Integer) 


71
72
73
 
# File 'lib/oci/opensearch/models/opensearch_cluster_summary.rb', line 71

def total_storage_gb
  @total_storage_gb
end

Class Method Details

.attribute_map ⇒ Object

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



92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'lib/oci/opensearch/models/opensearch_cluster_summary.rb', line 92

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'display_name': :'displayName',
    'compartment_id': :'compartmentId',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'lifecycle_details': :'lifecycleDetails',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags',
    'software_version': :'softwareVersion',
    'total_storage_gb': :'totalStorageGB',
    'lifecycle_state': :'lifecycleState',
    'availability_domains': :'availabilityDomains',
    'security_mode': :'securityMode',
    'backup_policy': :'backupPolicy',
    'outbound_cluster_config': :'outboundClusterConfig'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
 
# File 'lib/oci/opensearch/models/opensearch_cluster_summary.rb', line 116

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'display_name': :'String',
    'compartment_id': :'String',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'lifecycle_details': :'String',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'system_tags': :'Hash<String, Hash<String, Object>>',
    'software_version': :'String',
    'total_storage_gb': :'Integer',
    'lifecycle_state': :'String',
    'availability_domains': :'Array<String>',
    'security_mode': :'String',
    'backup_policy': :'OCI::Opensearch::Models::BackupPolicy',
    'outbound_cluster_config': :'OCI::Opensearch::Models::OutboundClusterConfig'
    # 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



280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
 
# File 'lib/oci/opensearch/models/opensearch_cluster_summary.rb', line 280

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

  self.class == other.class &&
    id == other.id &&
    display_name == other.display_name &&
    compartment_id == other.compartment_id &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    lifecycle_details == other.lifecycle_details &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    system_tags == other.system_tags &&
    software_version == other.software_version &&
    total_storage_gb == other.total_storage_gb &&
    lifecycle_state == other.lifecycle_state &&
    availability_domains == other.availability_domains &&
    security_mode == other.security_mode &&
    backup_policy == other.backup_policy &&
    outbound_cluster_config == other.outbound_cluster_config
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



325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
 
# File 'lib/oci/opensearch/models/opensearch_cluster_summary.rb', line 325

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


305
306
307
 
# File 'lib/oci/opensearch/models/opensearch_cluster_summary.rb', line 305

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



314
315
316
 
# File 'lib/oci/opensearch/models/opensearch_cluster_summary.rb', line 314

def hash
  [id, display_name, compartment_id, time_created, time_updated, lifecycle_details, freeform_tags, defined_tags, system_tags, software_version, total_storage_gb, lifecycle_state, availability_domains, security_mode, backup_policy, outbound_cluster_config].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



358
359
360
361
362
363
364
365
366
367
 
# File 'lib/oci/opensearch/models/opensearch_cluster_summary.rb', line 358

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



352
353
354
 
# File 'lib/oci/opensearch/models/opensearch_cluster_summary.rb', line 352

def to_s
  to_hash.to_s
end