Class: OCI::Redis::Models::RedisCluster
- Inherits:
-
Object
- Object
- OCI::Redis::Models::RedisCluster
- Defined in:
- lib/oci/redis/models/redis_cluster.rb
Overview
A Redis cluster is a memory-based storage solution. For more information, see OCI Caching Service with Redis.
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_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze ].freeze
Instance Attribute Summary collapse
-
#compartment_id ⇒ String
[Required] The OCID of the compartment that contains the Redis 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 Redis cluster.
-
#lifecycle_details ⇒ String
A message describing the current state in more detail.
-
#lifecycle_state ⇒ String
The current state of the Redis cluster.
-
#node_collection ⇒ OCI::Redis::Models::NodeCollection
This attribute is required.
-
#node_count ⇒ Integer
[Required] The number of nodes in the Redis cluster.
-
#node_memory_in_gbs ⇒ Float
[Required] The amount of memory allocated to the Redis cluster's nodes, in gigabytes.
-
#primary_endpoint_ip_address ⇒ String
[Required] The private IP address of the API endpoint for the Redis cluster's primary node.
-
#primary_fqdn ⇒ String
[Required] The fully qualified domain name (FQDN) of the API endpoint for the Redis cluster's primary node.
-
#replicas_endpoint_ip_address ⇒ String
[Required] The private IP address of the API endpoint for the Redis cluster's replica nodes.
-
#replicas_fqdn ⇒ String
[Required] The fully qualified domain name (FQDN) of the API endpoint for the Redis cluster's replica nodes.
-
#software_version ⇒ String
[Required] The Redis version that the cluster is running.
-
#subnet_id ⇒ String
[Required] The OCID of the Redis cluster's subnet.
-
#system_tags ⇒ Hash<String, Hash<String, Object>>
Usage of system tag keys.
-
#time_created ⇒ DateTime
The date and time the Redis cluster was created.
-
#time_updated ⇒ DateTime
The date and time the Redis 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
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 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 |
# File 'lib/oci/redis/models/redis_cluster.rb', line 188 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. = 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
#compartment_id ⇒ String
[Required] The OCID of the compartment that contains the Redis cluster.
37 38 39 |
# File 'lib/oci/redis/models/redis_cluster.rb', line 37 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\"}}
101 102 103 |
# File 'lib/oci/redis/models/redis_cluster.rb', line 101 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.
33 34 35 |
# File 'lib/oci/redis/models/redis_cluster.rb', line 33 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\"}
95 96 97 |
# File 'lib/oci/redis/models/redis_cluster.rb', line 95 def @freeform_tags end |
#id ⇒ String
[Required] The OCID of the Redis cluster.
29 30 31 |
# File 'lib/oci/redis/models/redis_cluster.rb', line 29 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.
45 46 47 |
# File 'lib/oci/redis/models/redis_cluster.rb', line 45 def lifecycle_details @lifecycle_details end |
#lifecycle_state ⇒ String
The current state of the Redis cluster.
41 42 43 |
# File 'lib/oci/redis/models/redis_cluster.rb', line 41 def lifecycle_state @lifecycle_state end |
#node_collection ⇒ OCI::Redis::Models::NodeCollection
This attribute is required.
89 90 91 |
# File 'lib/oci/redis/models/redis_cluster.rb', line 89 def node_collection @node_collection end |
#node_count ⇒ Integer
[Required] The number of nodes in the Redis cluster.
49 50 51 |
# File 'lib/oci/redis/models/redis_cluster.rb', line 49 def node_count @node_count end |
#node_memory_in_gbs ⇒ Float
[Required] The amount of memory allocated to the Redis cluster's nodes, in gigabytes.
53 54 55 |
# File 'lib/oci/redis/models/redis_cluster.rb', line 53 def node_memory_in_gbs @node_memory_in_gbs end |
#primary_endpoint_ip_address ⇒ String
[Required] The private IP address of the API endpoint for the Redis cluster's primary node.
61 62 63 |
# File 'lib/oci/redis/models/redis_cluster.rb', line 61 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 Redis cluster's primary node.
57 58 59 |
# File 'lib/oci/redis/models/redis_cluster.rb', line 57 def primary_fqdn @primary_fqdn end |
#replicas_endpoint_ip_address ⇒ String
[Required] The private IP address of the API endpoint for the Redis cluster's replica nodes.
69 70 71 |
# File 'lib/oci/redis/models/redis_cluster.rb', line 69 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 Redis cluster's replica nodes.
65 66 67 |
# File 'lib/oci/redis/models/redis_cluster.rb', line 65 def replicas_fqdn @replicas_fqdn end |
#software_version ⇒ String
[Required] The Redis version that the cluster is running.
73 74 75 |
# File 'lib/oci/redis/models/redis_cluster.rb', line 73 def software_version @software_version end |
#subnet_id ⇒ String
[Required] The OCID of the Redis cluster's subnet.
77 78 79 |
# File 'lib/oci/redis/models/redis_cluster.rb', line 77 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\"}}
107 108 109 |
# File 'lib/oci/redis/models/redis_cluster.rb', line 107 def @system_tags end |
#time_created ⇒ DateTime
The date and time the Redis cluster was created. An RFC3339 formatted datetime string.
81 82 83 |
# File 'lib/oci/redis/models/redis_cluster.rb', line 81 def time_created @time_created end |
#time_updated ⇒ DateTime
The date and time the Redis cluster was updated. An RFC3339 formatted datetime string.
85 86 87 |
# File 'lib/oci/redis/models/redis_cluster.rb', line 85 def time_updated @time_updated end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
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 |
# File 'lib/oci/redis/models/redis_cluster.rb', line 110 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', 'freeform_tags': :'freeformTags', 'defined_tags': :'definedTags', 'system_tags': :'systemTags' # rubocop:enable Style/SymbolLiteral } end |
.swagger_types ⇒ Object
Attribute type mapping.
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 |
# File 'lib/oci/redis/models/redis_cluster.rb', line 137 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', '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.
338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 |
# File 'lib/oci/redis/models/redis_cluster.rb', line 338 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 && == other. && == other. && == other. end |
#build_from_hash(attributes) ⇒ Object
Builds the object from hash
386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 |
# File 'lib/oci/redis/models/redis_cluster.rb', line 386 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
366 367 368 |
# File 'lib/oci/redis/models/redis_cluster.rb', line 366 def eql?(other) self == other end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
375 376 377 |
# File 'lib/oci/redis/models/redis_cluster.rb', line 375 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, , , ].hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
419 420 421 422 423 424 425 426 427 428 |
# File 'lib/oci/redis/models/redis_cluster.rb', line 419 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
413 414 415 |
# File 'lib/oci/redis/models/redis_cluster.rb', line 413 def to_s to_hash.to_s end |