Class: OCI::Redis::Models::RedisCluster
- Inherits:
-
Object
- Object
- OCI::Redis::Models::RedisCluster
- Defined in:
- lib/oci/redis/models/redis_cluster.rb
Overview
An OCI Cache cluster is a memory-based storage solution. For more information, see OCI Cache.
Constant Summary collapse
- LIFECYCLE_STATE_ENUM =
[ LIFECYCLE_STATE_CREATING = 'CREATING'.freeze, LIFECYCLE_STATE_UPDATING = 'UPDATING'.freeze, LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze, LIFECYCLE_STATE_DELETING = 'DELETING'.freeze, LIFECYCLE_STATE_DELETED = 'DELETED'.freeze, LIFECYCLE_STATE_FAILED = 'FAILED'.freeze, LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze ].freeze
- SOFTWARE_VERSION_ENUM =
[ SOFTWARE_VERSION_V7_0_5 = 'V7_0_5'.freeze, SOFTWARE_VERSION_REDIS_7_0 = 'REDIS_7_0'.freeze, SOFTWARE_VERSION_VALKEY_7_2 = 'VALKEY_7_2'.freeze, SOFTWARE_VERSION_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze ].freeze
- CLUSTER_MODE_ENUM =
[ CLUSTER_MODE_SHARDED = 'SHARDED'.freeze, CLUSTER_MODE_NONSHARDED = 'NONSHARDED'.freeze, CLUSTER_MODE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze ].freeze
Instance Attribute Summary collapse
-
#cluster_mode ⇒ String
Specifies whether the cluster is sharded or non-sharded.
-
#compartment_id ⇒ String
[Required] The OCID of the compartment that contains the cluster.
-
#defined_tags ⇒ Hash<String, Hash<String, Object>>
Defined tags for this resource.
-
#display_name ⇒ String
[Required] A user-friendly name.
-
#freeform_tags ⇒ Hash<String, String>
Simple key-value pair that is applied without any predefined name, type or scope.
-
#id ⇒ String
[Required] The OCID of the cluster.
-
#lifecycle_details ⇒ String
A message describing the current state in more detail.
-
#lifecycle_state ⇒ String
The current state of the cluster.
-
#node_collection ⇒ OCI::Redis::Models::NodeCollection
This attribute is required.
-
#node_count ⇒ Integer
[Required] The number of nodes per shard in the cluster when clusterMode is SHARDED.
-
#node_memory_in_gbs ⇒ Float
[Required] The amount of memory allocated to the cluster's nodes, in gigabytes.
-
#nsg_ids ⇒ Array<String>
A list of Network Security Group (NSG) OCIDs associated with this cluster.
-
#primary_endpoint_ip_address ⇒ String
[Required] The private IP address of the API endpoint for the cluster's primary node.
-
#primary_fqdn ⇒ String
[Required] The fully qualified domain name (FQDN) of the API endpoint for the cluster's primary node.
-
#replicas_endpoint_ip_address ⇒ String
[Required] The private IP address of the API endpoint for the cluster's replica nodes.
-
#replicas_fqdn ⇒ String
[Required] The fully qualified domain name (FQDN) of the API endpoint for the cluster's replica nodes.
-
#shard_count ⇒ Integer
The number of shards in a sharded cluster.
-
#software_version ⇒ String
[Required] The OCI Cache engine version that the cluster is running.
-
#subnet_id ⇒ String
[Required] The OCID of the cluster's subnet.
-
#system_tags ⇒ Hash<String, Hash<String, Object>>
Usage of system tag keys.
-
#time_created ⇒ DateTime
The date and time the cluster was created.
-
#time_updated ⇒ DateTime
The date and time the cluster was updated.
Class Method Summary collapse
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.swagger_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(other) ⇒ Object
Checks equality by comparing each attribute.
-
#build_from_hash(attributes) ⇒ Object
Builds the object from hash.
- #eql?(other) ⇒ Boolean
-
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ RedisCluster
constructor
Initializes the object.
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
Constructor Details
#initialize(attributes = {}) ⇒ RedisCluster
Initializes the object
220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 |
# File 'lib/oci/redis/models/redis_cluster.rb', line 220 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.id = attributes[:'id'] if attributes[:'id'] 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.lifecycle_state = attributes[:'lifecycleState'] if attributes[:'lifecycleState'] raise 'You cannot provide both :lifecycleState and :lifecycle_state' if attributes.key?(:'lifecycleState') && attributes.key?(:'lifecycle_state') self.lifecycle_state = attributes[:'lifecycle_state'] if attributes[:'lifecycle_state'] self.lifecycle_details = attributes[:'lifecycleDetails'] if attributes[:'lifecycleDetails'] raise 'You cannot provide both :lifecycleDetails and :lifecycle_details' if attributes.key?(:'lifecycleDetails') && attributes.key?(:'lifecycle_details') self.lifecycle_details = attributes[:'lifecycle_details'] if attributes[:'lifecycle_details'] 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.primary_fqdn = attributes[:'primaryFqdn'] if attributes[:'primaryFqdn'] raise 'You cannot provide both :primaryFqdn and :primary_fqdn' if attributes.key?(:'primaryFqdn') && attributes.key?(:'primary_fqdn') self.primary_fqdn = attributes[:'primary_fqdn'] if attributes[:'primary_fqdn'] self.primary_endpoint_ip_address = attributes[:'primaryEndpointIpAddress'] if attributes[:'primaryEndpointIpAddress'] raise 'You cannot provide both :primaryEndpointIpAddress and :primary_endpoint_ip_address' if attributes.key?(:'primaryEndpointIpAddress') && attributes.key?(:'primary_endpoint_ip_address') self.primary_endpoint_ip_address = attributes[:'primary_endpoint_ip_address'] if attributes[:'primary_endpoint_ip_address'] self.replicas_fqdn = attributes[:'replicasFqdn'] if attributes[:'replicasFqdn'] raise 'You cannot provide both :replicasFqdn and :replicas_fqdn' if attributes.key?(:'replicasFqdn') && attributes.key?(:'replicas_fqdn') self.replicas_fqdn = attributes[:'replicas_fqdn'] if attributes[:'replicas_fqdn'] self.replicas_endpoint_ip_address = attributes[:'replicasEndpointIpAddress'] if attributes[:'replicasEndpointIpAddress'] raise 'You cannot provide both :replicasEndpointIpAddress and :replicas_endpoint_ip_address' if attributes.key?(:'replicasEndpointIpAddress') && attributes.key?(:'replicas_endpoint_ip_address') self.replicas_endpoint_ip_address = attributes[:'replicas_endpoint_ip_address'] if attributes[:'replicas_endpoint_ip_address'] 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.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.time_created = attributes[:'timeCreated'] if attributes[:'timeCreated'] raise 'You cannot provide both :timeCreated and :time_created' if attributes.key?(:'timeCreated') && attributes.key?(:'time_created') self.time_created = attributes[:'time_created'] if attributes[:'time_created'] self.time_updated = attributes[:'timeUpdated'] if attributes[:'timeUpdated'] raise 'You cannot provide both :timeUpdated and :time_updated' if attributes.key?(:'timeUpdated') && attributes.key?(:'time_updated') self.time_updated = attributes[:'time_updated'] if attributes[:'time_updated'] self.node_collection = attributes[:'nodeCollection'] if attributes[:'nodeCollection'] raise 'You cannot provide both :nodeCollection and :node_collection' if attributes.key?(:'nodeCollection') && attributes.key?(:'node_collection') self.node_collection = attributes[:'node_collection'] if attributes[:'node_collection'] 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.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. = attributes[:'freeformTags'] if attributes[:'freeformTags'] raise 'You cannot provide both :freeformTags and :freeform_tags' if attributes.key?(:'freeformTags') && attributes.key?(:'freeform_tags') self. = attributes[:'freeform_tags'] if attributes[:'freeform_tags'] self. = attributes[:'definedTags'] if attributes[:'definedTags'] raise 'You cannot provide both :definedTags and :defined_tags' if attributes.key?(:'definedTags') && attributes.key?(:'defined_tags') self. = attributes[:'defined_tags'] if attributes[:'defined_tags'] self. = attributes[:'systemTags'] if attributes[:'systemTags'] raise 'You cannot provide both :systemTags and :system_tags' if attributes.key?(:'systemTags') && attributes.key?(:'system_tags') self. = attributes[:'system_tags'] if attributes[:'system_tags'] end |
Instance Attribute Details
#cluster_mode ⇒ String
Specifies whether the cluster is sharded or non-sharded.
101 102 103 |
# File 'lib/oci/redis/models/redis_cluster.rb', line 101 def cluster_mode @cluster_mode end |
#compartment_id ⇒ String
[Required] The OCID of the compartment that contains the cluster.
45 46 47 |
# File 'lib/oci/redis/models/redis_cluster.rb', line 45 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\"}}
124 125 126 |
# File 'lib/oci/redis/models/redis_cluster.rb', line 124 def @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.
41 42 43 |
# File 'lib/oci/redis/models/redis_cluster.rb', line 41 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\"}
118 119 120 |
# File 'lib/oci/redis/models/redis_cluster.rb', line 118 def @freeform_tags end |
#id ⇒ String
[Required] The OCID of the cluster.
37 38 39 |
# File 'lib/oci/redis/models/redis_cluster.rb', line 37 def id @id end |
#lifecycle_details ⇒ String
A message describing the current state in more detail. For example, the message might provide actionable information for a resource in FAILED
state.
53 54 55 |
# File 'lib/oci/redis/models/redis_cluster.rb', line 53 def lifecycle_details @lifecycle_details end |
#lifecycle_state ⇒ String
The current state of the cluster.
49 50 51 |
# File 'lib/oci/redis/models/redis_cluster.rb', line 49 def lifecycle_state @lifecycle_state end |
#node_collection ⇒ OCI::Redis::Models::NodeCollection
This attribute is required.
97 98 99 |
# File 'lib/oci/redis/models/redis_cluster.rb', line 97 def node_collection @node_collection 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.
57 58 59 |
# File 'lib/oci/redis/models/redis_cluster.rb', line 57 def node_count @node_count end |
#node_memory_in_gbs ⇒ Float
[Required] The amount of memory allocated to the cluster's nodes, in gigabytes.
61 62 63 |
# File 'lib/oci/redis/models/redis_cluster.rb', line 61 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.
112 113 114 |
# File 'lib/oci/redis/models/redis_cluster.rb', line 112 def nsg_ids @nsg_ids end |
#primary_endpoint_ip_address ⇒ String
[Required] The private IP address of the API endpoint for the cluster's primary node.
69 70 71 |
# File 'lib/oci/redis/models/redis_cluster.rb', line 69 def primary_endpoint_ip_address @primary_endpoint_ip_address end |
#primary_fqdn ⇒ String
[Required] The fully qualified domain name (FQDN) of the API endpoint for the cluster's primary node.
65 66 67 |
# File 'lib/oci/redis/models/redis_cluster.rb', line 65 def primary_fqdn @primary_fqdn end |
#replicas_endpoint_ip_address ⇒ String
[Required] The private IP address of the API endpoint for the cluster's replica nodes.
77 78 79 |
# File 'lib/oci/redis/models/redis_cluster.rb', line 77 def replicas_endpoint_ip_address @replicas_endpoint_ip_address end |
#replicas_fqdn ⇒ String
[Required] The fully qualified domain name (FQDN) of the API endpoint for the cluster's replica nodes.
73 74 75 |
# File 'lib/oci/redis/models/redis_cluster.rb', line 73 def replicas_fqdn @replicas_fqdn end |
#shard_count ⇒ Integer
The number of shards in a sharded cluster. Only applicable when clusterMode is SHARDED.
105 106 107 |
# File 'lib/oci/redis/models/redis_cluster.rb', line 105 def shard_count @shard_count end |
#software_version ⇒ String
[Required] The OCI Cache engine version that the cluster is running.
81 82 83 |
# File 'lib/oci/redis/models/redis_cluster.rb', line 81 def software_version @software_version end |
#subnet_id ⇒ String
[Required] The OCID of the cluster's subnet.
85 86 87 |
# File 'lib/oci/redis/models/redis_cluster.rb', line 85 def subnet_id @subnet_id end |
#system_tags ⇒ Hash<String, Hash<String, Object>>
Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}
130 131 132 |
# File 'lib/oci/redis/models/redis_cluster.rb', line 130 def @system_tags end |
#time_created ⇒ DateTime
The date and time the cluster was created. An RFC3339 formatted datetime string.
89 90 91 |
# File 'lib/oci/redis/models/redis_cluster.rb', line 89 def time_created @time_created end |
#time_updated ⇒ DateTime
The date and time the cluster was updated. An RFC3339 formatted datetime string.
93 94 95 |
# File 'lib/oci/redis/models/redis_cluster.rb', line 93 def time_updated @time_updated end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
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 |
# File 'lib/oci/redis/models/redis_cluster.rb', line 133 def self.attribute_map { # rubocop:disable Style/SymbolLiteral 'id': :'id', 'display_name': :'displayName', 'compartment_id': :'compartmentId', 'lifecycle_state': :'lifecycleState', 'lifecycle_details': :'lifecycleDetails', 'node_count': :'nodeCount', 'node_memory_in_gbs': :'nodeMemoryInGBs', 'primary_fqdn': :'primaryFqdn', 'primary_endpoint_ip_address': :'primaryEndpointIpAddress', 'replicas_fqdn': :'replicasFqdn', 'replicas_endpoint_ip_address': :'replicasEndpointIpAddress', 'software_version': :'softwareVersion', 'subnet_id': :'subnetId', 'time_created': :'timeCreated', 'time_updated': :'timeUpdated', 'node_collection': :'nodeCollection', 'cluster_mode': :'clusterMode', 'shard_count': :'shardCount', 'nsg_ids': :'nsgIds', 'freeform_tags': :'freeformTags', 'defined_tags': :'definedTags', 'system_tags': :'systemTags' # rubocop:enable Style/SymbolLiteral } end |
.swagger_types ⇒ Object
Attribute type mapping.
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 |
# File 'lib/oci/redis/models/redis_cluster.rb', line 163 def self.swagger_types { # rubocop:disable Style/SymbolLiteral 'id': :'String', 'display_name': :'String', 'compartment_id': :'String', 'lifecycle_state': :'String', 'lifecycle_details': :'String', 'node_count': :'Integer', 'node_memory_in_gbs': :'Float', 'primary_fqdn': :'String', 'primary_endpoint_ip_address': :'String', 'replicas_fqdn': :'String', 'replicas_endpoint_ip_address': :'String', 'software_version': :'String', 'subnet_id': :'String', 'time_created': :'DateTime', 'time_updated': :'DateTime', 'node_collection': :'OCI::Redis::Models::NodeCollection', 'cluster_mode': :'String', 'shard_count': :'Integer', 'nsg_ids': :'Array<String>', 'freeform_tags': :'Hash<String, String>', 'defined_tags': :'Hash<String, Hash<String, Object>>', 'system_tags': :'Hash<String, Hash<String, Object>>' # rubocop:enable Style/SymbolLiteral } end |
Instance Method Details
#==(other) ⇒ Object
Checks equality by comparing each attribute.
401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 |
# File 'lib/oci/redis/models/redis_cluster.rb', line 401 def ==(other) return true if equal?(other) self.class == other.class && id == other.id && display_name == other.display_name && compartment_id == other.compartment_id && lifecycle_state == other.lifecycle_state && lifecycle_details == other.lifecycle_details && node_count == other.node_count && node_memory_in_gbs == other.node_memory_in_gbs && primary_fqdn == other.primary_fqdn && primary_endpoint_ip_address == other.primary_endpoint_ip_address && replicas_fqdn == other.replicas_fqdn && replicas_endpoint_ip_address == other.replicas_endpoint_ip_address && software_version == other.software_version && subnet_id == other.subnet_id && time_created == other.time_created && time_updated == other.time_updated && node_collection == other.node_collection && cluster_mode == other.cluster_mode && shard_count == other.shard_count && nsg_ids == other.nsg_ids && == other. && == other. && == other. end |
#build_from_hash(attributes) ⇒ Object
Builds the object from hash
452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 |
# File 'lib/oci/redis/models/redis_cluster.rb', line 452 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
432 433 434 |
# File 'lib/oci/redis/models/redis_cluster.rb', line 432 def eql?(other) self == other end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
441 442 443 |
# File 'lib/oci/redis/models/redis_cluster.rb', line 441 def hash [id, display_name, compartment_id, lifecycle_state, lifecycle_details, node_count, node_memory_in_gbs, primary_fqdn, primary_endpoint_ip_address, replicas_fqdn, replicas_endpoint_ip_address, software_version, subnet_id, time_created, time_updated, node_collection, cluster_mode, shard_count, nsg_ids, , , ].hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
485 486 487 488 489 490 491 492 493 494 |
# File 'lib/oci/redis/models/redis_cluster.rb', line 485 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
479 480 481 |
# File 'lib/oci/redis/models/redis_cluster.rb', line 479 def to_s to_hash.to_s end |