Class: OCI::Opensearch::Models::ResizeOpensearchClusterHorizontalDetails

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

Overview

The node count configuration to update on an existing OpenSearch cluster for horizontal resizing.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ResizeOpensearchClusterHorizontalDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :master_node_count (Integer)

    The value to assign to the #master_node_count property

  • :data_node_count (Integer)

    The value to assign to the #data_node_count property

  • :opendashboard_node_count (Integer)

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



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
# File 'lib/oci/opensearch/models/resize_opensearch_cluster_horizontal_details.rb', line 72

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

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

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

  self.data_node_count = attributes[:'dataNodeCount'] if attributes[:'dataNodeCount']

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

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

  self.opendashboard_node_count = attributes[:'opendashboardNodeCount'] if attributes[:'opendashboardNodeCount']

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

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

  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

#data_node_countInteger

The number of data nodes to configure for the cluster.

Returns:

  • (Integer)


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

def data_node_count
  @data_node_count
end

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


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

def defined_tags
  @defined_tags
end

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


27
28
29
# File 'lib/oci/opensearch/models/resize_opensearch_cluster_horizontal_details.rb', line 27

def freeform_tags
  @freeform_tags
end

#master_node_countInteger

The number of master nodes to configure for the cluster.

Returns:

  • (Integer)


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

def master_node_count
  @master_node_count
end

#opendashboard_node_countInteger

The number of OpenSearch Dashboard nodes to configure for the cluster.

Returns:

  • (Integer)


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

def opendashboard_node_count
  @opendashboard_node_count
end

Class Method Details

.attribute_mapObject

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



36
37
38
39
40
41
42
43
44
45
46
# File 'lib/oci/opensearch/models/resize_opensearch_cluster_horizontal_details.rb', line 36

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'master_node_count': :'masterNodeCount',
    'data_node_count': :'dataNodeCount',
    'opendashboard_node_count': :'opendashboardNodeCount',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_typesObject

Attribute type mapping.



49
50
51
52
53
54
55
56
57
58
59
# File 'lib/oci/opensearch/models/resize_opensearch_cluster_horizontal_details.rb', line 49

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'master_node_count': :'Integer',
    'data_node_count': :'Integer',
    'opendashboard_node_count': :'Integer',
    '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



116
117
118
119
120
121
122
123
124
125
# File 'lib/oci/opensearch/models/resize_opensearch_cluster_horizontal_details.rb', line 116

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

  self.class == other.class &&
    master_node_count == other.master_node_count &&
    data_node_count == other.data_node_count &&
    opendashboard_node_count == other.opendashboard_node_count &&
    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



150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
# File 'lib/oci/opensearch/models/resize_opensearch_cluster_horizontal_details.rb', line 150

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


130
131
132
# File 'lib/oci/opensearch/models/resize_opensearch_cluster_horizontal_details.rb', line 130

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



139
140
141
# File 'lib/oci/opensearch/models/resize_opensearch_cluster_horizontal_details.rb', line 139

def hash
  [master_node_count, data_node_count, opendashboard_node_count, freeform_tags, defined_tags].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



183
184
185
186
187
188
189
190
191
192
# File 'lib/oci/opensearch/models/resize_opensearch_cluster_horizontal_details.rb', line 183

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



177
178
179
# File 'lib/oci/opensearch/models/resize_opensearch_cluster_horizontal_details.rb', line 177

def to_s
  to_hash.to_s
end