Class: OCI::Redis::Models::UpdateRedisClusterDetails

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/redis/models/update_redis_cluster_details.rb

Overview

The configuration to update for an existing cluster.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ UpdateRedisClusterDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :oci_cache_config_set_id (String) —

    The value to assign to the #oci_cache_config_set_id property

  • :shard_count (Integer) —

    The value to assign to the #shard_count property

  • :display_name (String) —

    The value to assign to the #display_name property

  • :node_count (Integer) —

    The value to assign to the #node_count property

  • :node_memory_in_gbs (Float) —

    The value to assign to the #node_memory_in_gbs property

  • :software_version (String) —

    The value to assign to the #software_version property

  • :nsg_ids (Array<String>) —

    The value to assign to the #nsg_ids property

  • :security_attributes (Hash<String, Hash<String, Object>>) —

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



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
141
142
143
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
 
# File 'lib/oci/redis/models/update_redis_cluster_details.rb', line 114

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

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

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

  self.shard_count = attributes[:'shardCount'] if attributes[:'shardCount']

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

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

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

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

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

  self.node_memory_in_gbs = attributes[:'nodeMemoryInGBs'] if attributes[:'nodeMemoryInGBs']

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

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

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

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

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

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

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


60
61
62
 
# File 'lib/oci/redis/models/update_redis_cluster_details.rb', line 60

def defined_tags
  @defined_tags
end

#display_name ⇒ String

A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

Returns:

  • (String) 


21
22
23
 
# File 'lib/oci/redis/models/update_redis_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>) 


54
55
56
 
# File 'lib/oci/redis/models/update_redis_cluster_details.rb', line 54

def freeform_tags
  @freeform_tags
end

#node_count ⇒ Integer

The number of nodes per shard in the cluster when clusterMode is SHARDED. This is the total number of nodes when clusterMode is NONSHARDED.

Returns:

  • (Integer) 


25
26
27
 
# File 'lib/oci/redis/models/update_redis_cluster_details.rb', line 25

def node_count
  @node_count
end

#node_memory_in_gbs ⇒ Float

The amount of memory allocated to the cluster's nodes, in gigabytes.

Returns:

  • (Float) 


29
30
31
 
# File 'lib/oci/redis/models/update_redis_cluster_details.rb', line 29

def node_memory_in_gbs
  @node_memory_in_gbs
end

#nsg_ids ⇒ Array<String>

A list of Network Security Group (NSG) OCIDs associated with this cluster. For more information, see Using an NSG for Clusters.

Returns:

  • (Array<String>) 


40
41
42
 
# File 'lib/oci/redis/models/update_redis_cluster_details.rb', line 40

def nsg_ids
  @nsg_ids
end

#oci_cache_config_set_id ⇒ String

The ID of the corresponding OCI Cache Config Set for the cluster.

Returns:

  • (String) 


13
14
15
 
# File 'lib/oci/redis/models/update_redis_cluster_details.rb', line 13

def oci_cache_config_set_id
  @oci_cache_config_set_id
end

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

Security attributes for redis cluster 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>>) 


48
49
50
 
# File 'lib/oci/redis/models/update_redis_cluster_details.rb', line 48

def security_attributes
  @security_attributes
end

#shard_count ⇒ Integer

The number of shards in sharded cluster. Only applicable when clusterMode is SHARDED.

Returns:

  • (Integer) 


17
18
19
 
# File 'lib/oci/redis/models/update_redis_cluster_details.rb', line 17

def shard_count
  @shard_count
end

#software_version ⇒ String

The OCI Cache engine version that the cluster is running.

Returns:

  • (String) 


33
34
35
 
# File 'lib/oci/redis/models/update_redis_cluster_details.rb', line 33

def software_version
  @software_version
end

Class Method Details

.attribute_map ⇒ Object

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



63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/oci/redis/models/update_redis_cluster_details.rb', line 63

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'oci_cache_config_set_id': :'ociCacheConfigSetId',
    'shard_count': :'shardCount',
    'display_name': :'displayName',
    'node_count': :'nodeCount',
    'node_memory_in_gbs': :'nodeMemoryInGBs',
    'software_version': :'softwareVersion',
    'nsg_ids': :'nsgIds',
    'security_attributes': :'securityAttributes',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/oci/redis/models/update_redis_cluster_details.rb', line 81

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'oci_cache_config_set_id': :'String',
    'shard_count': :'Integer',
    'display_name': :'String',
    'node_count': :'Integer',
    'node_memory_in_gbs': :'Float',
    'software_version': :'String',
    'nsg_ids': :'Array<String>',
    'security_attributes': :'Hash<String, Hash<String, Object>>',
    '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



188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
 
# File 'lib/oci/redis/models/update_redis_cluster_details.rb', line 188

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

  self.class == other.class &&
    oci_cache_config_set_id == other.oci_cache_config_set_id &&
    shard_count == other.shard_count &&
    display_name == other.display_name &&
    node_count == other.node_count &&
    node_memory_in_gbs == other.node_memory_in_gbs &&
    software_version == other.software_version &&
    nsg_ids == other.nsg_ids &&
    security_attributes == other.security_attributes &&
    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



227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
 
# File 'lib/oci/redis/models/update_redis_cluster_details.rb', line 227

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


207
208
209
 
# File 'lib/oci/redis/models/update_redis_cluster_details.rb', line 207

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



216
217
218
 
# File 'lib/oci/redis/models/update_redis_cluster_details.rb', line 216

def hash
  [oci_cache_config_set_id, shard_count, display_name, node_count, node_memory_in_gbs, software_version, nsg_ids, security_attributes, 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



260
261
262
263
264
265
266
267
268
269
 
# File 'lib/oci/redis/models/update_redis_cluster_details.rb', line 260

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



254
255
256
 
# File 'lib/oci/redis/models/update_redis_cluster_details.rb', line 254

def to_s
  to_hash.to_s
end