Class: OCI::Opensearch::Models::UpdateOpensearchClusterDetails

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

Overview

The configuration to update on an existing OpenSearch cluster. Software version and security config are not allowed to be updated at the same time.

Constant Summary collapse

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ UpdateOpensearchClusterDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
236
237
238
239
240
241
242
 
# File 'lib/oci/opensearch/models/update_opensearch_cluster_details.rb', line 147

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

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

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

  self.security_master_user_password_hash = attributes[:'securityMasterUserPasswordHash'] if attributes[:'securityMasterUserPasswordHash']

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

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

  self.security_saml_config = attributes[:'securitySamlConfig'] if attributes[:'securitySamlConfig']

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

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

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

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

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

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

  self.maintenance_details = attributes[:'maintenanceDetails'] if attributes[:'maintenanceDetails']

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

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

  self.load_balancer_config = attributes[:'loadBalancerConfig'] if attributes[:'loadBalancerConfig']

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

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

  self.certificate_config = attributes[:'certificateConfig'] if attributes[:'certificateConfig']

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

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

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

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

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

Instance Attribute Details

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

Returns:



42
43
44
 
# File 'lib/oci/opensearch/models/update_opensearch_cluster_details.rb', line 42

def backup_policy
  @backup_policy
end

#certificate_config ⇒ OCI::Opensearch::Models::CertificateConfig

Returns:



58
59
60
 
# File 'lib/oci/opensearch/models/update_opensearch_cluster_details.rb', line 58

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


70
71
72
 
# File 'lib/oci/opensearch/models/update_opensearch_cluster_details.rb', line 70

def defined_tags
  @defined_tags
end

#display_name ⇒ String

[Required] The name of the cluster. Avoid entering confidential information.

Returns:

  • (String) 


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

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


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

def freeform_tags
  @freeform_tags
end

#load_balancer_config ⇒ OCI::Opensearch::Models::LoadBalancerConfig

Returns:



55
56
57
 
# File 'lib/oci/opensearch/models/update_opensearch_cluster_details.rb', line 55

def load_balancer_config
  @load_balancer_config
end

#maintenance_details ⇒ OCI::Opensearch::Models::UpdateMaintenanceDetails

Returns:



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

def maintenance_details
  @maintenance_details
end

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

Returns:



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

def outbound_cluster_config
  @outbound_cluster_config
end

#reverse_connection_endpoint_customer_ips ⇒ Array<String>

The customer IP addresses of the endpoint in customer VCN

Returns:

  • (Array<String>) 


46
47
48
 
# File 'lib/oci/opensearch/models/update_opensearch_cluster_details.rb', line 46

def reverse_connection_endpoint_customer_ips
  @reverse_connection_endpoint_customer_ips
end

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

Security attributes for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

Example: {\"Oracle-ZPR\": {\"MaxEgressCount\": {\"value\": \"42\", \"mode\": \"enforce\"}}}

Returns:

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


78
79
80
 
# File 'lib/oci/opensearch/models/update_opensearch_cluster_details.rb', line 78

def security_attributes
  @security_attributes
end

#security_master_user_name ⇒ String

The name of the master user that are used to manage security config

Returns:

  • (String) 


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

def security_master_user_name
  @security_master_user_name
end

#security_master_user_password_hash ⇒ String

The password hash of the master user that are used to manage security config

Returns:

  • (String) 


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

def security_master_user_password_hash
  @security_master_user_password_hash
end

#security_mode ⇒ String

The security mode of the cluster.

Returns:

  • (String) 


28
29
30
 
# File 'lib/oci/opensearch/models/update_opensearch_cluster_details.rb', line 28

def security_mode
  @security_mode
end

#security_saml_config ⇒ OCI::Opensearch::Models::SecuritySamlConfig

Returns:



39
40
41
 
# File 'lib/oci/opensearch/models/update_opensearch_cluster_details.rb', line 39

def security_saml_config
  @security_saml_config
end

#software_version ⇒ String

Returns:

  • (String) 


24
25
26
 
# File 'lib/oci/opensearch/models/update_opensearch_cluster_details.rb', line 24

def software_version
  @software_version
end

Class Method Details

.attribute_map ⇒ Object

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



81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
 
# File 'lib/oci/opensearch/models/update_opensearch_cluster_details.rb', line 81

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'display_name': :'displayName',
    'software_version': :'softwareVersion',
    'security_mode': :'securityMode',
    'security_master_user_name': :'securityMasterUserName',
    'security_master_user_password_hash': :'securityMasterUserPasswordHash',
    'security_saml_config': :'securitySamlConfig',
    'backup_policy': :'backupPolicy',
    'reverse_connection_endpoint_customer_ips': :'reverseConnectionEndpointCustomerIps',
    'outbound_cluster_config': :'outboundClusterConfig',
    'maintenance_details': :'maintenanceDetails',
    'load_balancer_config': :'loadBalancerConfig',
    'certificate_config': :'certificateConfig',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'security_attributes': :'securityAttributes'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
 
# File 'lib/oci/opensearch/models/update_opensearch_cluster_details.rb', line 104

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'display_name': :'String',
    'software_version': :'String',
    'security_mode': :'String',
    'security_master_user_name': :'String',
    'security_master_user_password_hash': :'String',
    'security_saml_config': :'OCI::Opensearch::Models::SecuritySamlConfig',
    'backup_policy': :'OCI::Opensearch::Models::BackupPolicy',
    'reverse_connection_endpoint_customer_ips': :'Array<String>',
    'outbound_cluster_config': :'OCI::Opensearch::Models::OutboundClusterConfig',
    'maintenance_details': :'OCI::Opensearch::Models::UpdateMaintenanceDetails',
    'load_balancer_config': :'OCI::Opensearch::Models::LoadBalancerConfig',
    'certificate_config': :'OCI::Opensearch::Models::CertificateConfig',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'security_attributes': :'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



259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
 
# File 'lib/oci/opensearch/models/update_opensearch_cluster_details.rb', line 259

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

  self.class == other.class &&
    display_name == other.display_name &&
    software_version == other.software_version &&
    security_mode == other.security_mode &&
    security_master_user_name == other.security_master_user_name &&
    security_master_user_password_hash == other.security_master_user_password_hash &&
    security_saml_config == other.security_saml_config &&
    backup_policy == other.backup_policy &&
    reverse_connection_endpoint_customer_ips == other.reverse_connection_endpoint_customer_ips &&
    outbound_cluster_config == other.outbound_cluster_config &&
    maintenance_details == other.maintenance_details &&
    load_balancer_config == other.load_balancer_config &&
    certificate_config == other.certificate_config &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    security_attributes == other.security_attributes
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



303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
 
# File 'lib/oci/opensearch/models/update_opensearch_cluster_details.rb', line 303

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


283
284
285
 
# File 'lib/oci/opensearch/models/update_opensearch_cluster_details.rb', line 283

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



292
293
294
 
# File 'lib/oci/opensearch/models/update_opensearch_cluster_details.rb', line 292

def hash
  [display_name, software_version, security_mode, security_master_user_name, security_master_user_password_hash, security_saml_config, backup_policy, reverse_connection_endpoint_customer_ips, outbound_cluster_config, maintenance_details, load_balancer_config, certificate_config, freeform_tags, defined_tags, security_attributes].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



336
337
338
339
340
341
342
343
344
345
 
# File 'lib/oci/opensearch/models/update_opensearch_cluster_details.rb', line 336

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



330
331
332
 
# File 'lib/oci/opensearch/models/update_opensearch_cluster_details.rb', line 330

def to_s
  to_hash.to_s
end