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

  • :display_name (String) —

    The value to assign to the #display_name property

  • :software_version (String) —

    The value to assign to the #software_version property

  • :security_mode (String) —

    The value to assign to the #security_mode property

  • :security_master_user_name (String) —

    The value to assign to the #security_master_user_name property

  • :security_master_user_password_hash (String) —

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



93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
 
# File 'lib/oci/opensearch/models/update_opensearch_cluster_details.rb', line 93

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

Instance Attribute Details

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


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

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


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

def freeform_tags
  @freeform_tags
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

#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.



51
52
53
54
55
56
57
58
59
60
61
62
63
 
# File 'lib/oci/opensearch/models/update_opensearch_cluster_details.rb', line 51

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',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



66
67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/oci/opensearch/models/update_opensearch_cluster_details.rb', line 66

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',
    'freeform_tags': :'Hash<String, String>',
    'defined_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



157
158
159
160
161
162
163
164
165
166
167
168
 
# File 'lib/oci/opensearch/models/update_opensearch_cluster_details.rb', line 157

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 &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_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



193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
 
# File 'lib/oci/opensearch/models/update_opensearch_cluster_details.rb', line 193

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


173
174
175
 
# File 'lib/oci/opensearch/models/update_opensearch_cluster_details.rb', line 173

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



182
183
184
 
# File 'lib/oci/opensearch/models/update_opensearch_cluster_details.rb', line 182

def hash
  [display_name, software_version, security_mode, security_master_user_name, security_master_user_password_hash, freeform_tags, defined_tags].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



226
227
228
229
230
231
232
233
234
235
 
# File 'lib/oci/opensearch/models/update_opensearch_cluster_details.rb', line 226

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



220
221
222
 
# File 'lib/oci/opensearch/models/update_opensearch_cluster_details.rb', line 220

def to_s
  to_hash.to_s
end