Class: OCI::Redis::Models::CreateRedisClusterDetails

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

Overview

The configuration details for a new OCI Cache cluster. An OCI Cache cluster is a memory-based storage solution. For more information, see OCI Cache.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateRedisClusterDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
243
 
# File 'lib/oci/redis/models/create_redis_cluster_details.rb', line 148

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

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

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

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

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

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

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

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

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

  self.import_from_object_storage_details = attributes[:'importFromObjectStorageDetails'] if attributes[:'importFromObjectStorageDetails']

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

  self.import_from_object_storage_details = attributes[:'import_from_object_storage_details'] if attributes[:'import_from_object_storage_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']
end

Instance Attribute Details

#backup_id ⇒ String

The ID of the OCI Cache Backup from which this cluster was created.Mutually exclusive with 'importFromObjectStorageDetails'.

Returns:

  • (String) 


64
65
66
 
# File 'lib/oci/redis/models/create_redis_cluster_details.rb', line 64

def backup_id
  @backup_id
end

#cluster_mode ⇒ String

Specifies whether the cluster is sharded or non-sharded.

Returns:

  • (String) 


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

def cluster_mode
  @cluster_mode
end

#compartment_id ⇒ String

[Required] The OCID of the compartment that contains the cluster.

Returns:

  • (String) 


29
30
31
 
# File 'lib/oci/redis/models/create_redis_cluster_details.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>>) 


79
80
81
 
# File 'lib/oci/redis/models/create_redis_cluster_details.rb', line 79

def defined_tags
  @defined_tags
end

#display_name ⇒ String

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

Returns:

  • (String) 


25
26
27
 
# File 'lib/oci/redis/models/create_redis_cluster_details.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>) 


73
74
75
 
# File 'lib/oci/redis/models/create_redis_cluster_details.rb', line 73

def freeform_tags
  @freeform_tags
end

#import_from_object_storage_details ⇒ OCI::Redis::Models::ImportOciCacheFromObjectStorageDetails

Returns:



67
68
69
 
# File 'lib/oci/redis/models/create_redis_cluster_details.rb', line 67

def import_from_object_storage_details
  @import_from_object_storage_details
end

#node_count ⇒ Integer

[Required] 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) 


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

def node_count
  @node_count
end

#node_memory_in_gbs ⇒ Float

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

Returns:

  • (Float) 


41
42
43
 
# File 'lib/oci/redis/models/create_redis_cluster_details.rb', line 41

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


52
53
54
 
# File 'lib/oci/redis/models/create_redis_cluster_details.rb', line 52

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


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

def security_attributes
  @security_attributes
end

#shard_count ⇒ Integer

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

Returns:

  • (Integer) 


21
22
23
 
# File 'lib/oci/redis/models/create_redis_cluster_details.rb', line 21

def shard_count
  @shard_count
end

#software_version ⇒ String

[Required] The OCI Cache engine version that the cluster is running.

Returns:

  • (String) 


37
38
39
 
# File 'lib/oci/redis/models/create_redis_cluster_details.rb', line 37

def software_version
  @software_version
end

#subnet_id ⇒ String

[Required] The OCID of the cluster's subnet.

Returns:

  • (String) 


45
46
47
 
# File 'lib/oci/redis/models/create_redis_cluster_details.rb', line 45

def subnet_id
  @subnet_id
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'oci_cache_config_set_id': :'ociCacheConfigSetId',
    'cluster_mode': :'clusterMode',
    'shard_count': :'shardCount',
    'display_name': :'displayName',
    'compartment_id': :'compartmentId',
    'node_count': :'nodeCount',
    'software_version': :'softwareVersion',
    'node_memory_in_gbs': :'nodeMemoryInGBs',
    'subnet_id': :'subnetId',
    'nsg_ids': :'nsgIds',
    'security_attributes': :'securityAttributes',
    'backup_id': :'backupId',
    'import_from_object_storage_details': :'importFromObjectStorageDetails',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

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



252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
 
# File 'lib/oci/redis/models/create_redis_cluster_details.rb', line 252

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

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



296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
 
# File 'lib/oci/redis/models/create_redis_cluster_details.rb', line 296

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


276
277
278
 
# File 'lib/oci/redis/models/create_redis_cluster_details.rb', line 276

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



285
286
287
 
# File 'lib/oci/redis/models/create_redis_cluster_details.rb', line 285

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



329
330
331
332
333
334
335
336
337
338
 
# File 'lib/oci/redis/models/create_redis_cluster_details.rb', line 329

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



323
324
325
 
# File 'lib/oci/redis/models/create_redis_cluster_details.rb', line 323

def to_s
  to_hash.to_s
end