Class: OCI::Core::Models::InstancePool
- Inherits:
-
Object
- Object
- OCI::Core::Models::InstancePool
- Defined in:
- lib/oci/core/models/instance_pool.rb
Overview
An instance pool is a group of instances within the same region that are created based off of the same instance configuration. For more information about instance pools and instance configurations, see Managing Compute Instances.
Constant Summary collapse
- LIFECYCLE_STATE_ENUM =
[ LIFECYCLE_STATE_PROVISIONING = 'PROVISIONING'.freeze, LIFECYCLE_STATE_SCALING = 'SCALING'.freeze, LIFECYCLE_STATE_STARTING = 'STARTING'.freeze, LIFECYCLE_STATE_STOPPING = 'STOPPING'.freeze, LIFECYCLE_STATE_TERMINATING = 'TERMINATING'.freeze, LIFECYCLE_STATE_STOPPED = 'STOPPED'.freeze, LIFECYCLE_STATE_TERMINATED = 'TERMINATED'.freeze, LIFECYCLE_STATE_RUNNING = 'RUNNING'.freeze, LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze ].freeze
Instance Attribute Summary collapse
-
#compartment_id ⇒ String
[Required] The OCID of the compartment containing the instance pool.
-
#defined_tags ⇒ Hash<String, Hash<String, Object>>
Defined tags for this resource.
-
#display_name ⇒ String
The user-friendly name.
-
#freeform_tags ⇒ Hash<String, String>
Free-form tags for this resource.
-
#id ⇒ String
[Required] The OCID of the instance pool.
-
#instance_configuration_id ⇒ String
[Required] The OCID of the instance configuration associated with the instance pool.
-
#lifecycle_state ⇒ String
[Required] The current state of the instance pool.
-
#load_balancers ⇒ Array<OCI::Core::Models::InstancePoolLoadBalancerAttachment>
The load balancers attached to the instance pool.
-
#placement_configurations ⇒ Array<OCI::Core::Models::InstancePoolPlacementConfiguration>
[Required] The placement configurations for the instance pool.
-
#size ⇒ Integer
[Required] The number of instances that should be in the instance pool.
-
#time_created ⇒ DateTime
[Required] The date and time the instance pool was created, in the format defined by RFC3339.
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 = {}) ⇒ InstancePool
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 = {}) ⇒ InstancePool
Initializes the object
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 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 |
# File 'lib/oci/core/models/instance_pool.rb', line 140 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.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. = 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.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. = 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.instance_configuration_id = attributes[:'instanceConfigurationId'] if attributes[:'instanceConfigurationId'] raise 'You cannot provide both :instanceConfigurationId and :instance_configuration_id' if attributes.key?(:'instanceConfigurationId') && attributes.key?(:'instance_configuration_id') self.instance_configuration_id = attributes[:'instance_configuration_id'] if attributes[:'instance_configuration_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.placement_configurations = attributes[:'placementConfigurations'] if attributes[:'placementConfigurations'] raise 'You cannot provide both :placementConfigurations and :placement_configurations' if attributes.key?(:'placementConfigurations') && attributes.key?(:'placement_configurations') self.placement_configurations = attributes[:'placement_configurations'] if attributes[:'placement_configurations'] self.size = attributes[:'size'] if attributes[:'size'] 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.load_balancers = attributes[:'loadBalancers'] if attributes[:'loadBalancers'] raise 'You cannot provide both :loadBalancers and :load_balancers' if attributes.key?(:'loadBalancers') && attributes.key?(:'load_balancers') self.load_balancers = attributes[:'load_balancers'] if attributes[:'load_balancers'] end |
Instance Attribute Details
#compartment_id ⇒ String
[Required] The OCID of the compartment containing the instance pool.
34 35 36 |
# File 'lib/oci/core/models/instance_pool.rb', line 34 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. For more information, see Resource Tags.
Example: {\"Operations\": {\"CostCenter\": \"42\"}}
42 43 44 |
# File 'lib/oci/core/models/instance_pool.rb', line 42 def @defined_tags end |
#display_name ⇒ String
The user-friendly name. Does not have to be unique.
46 47 48 |
# File 'lib/oci/core/models/instance_pool.rb', line 46 def display_name @display_name end |
#freeform_tags ⇒ Hash<String, String>
Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags.
Example: {\"Department\": \"Finance\"}
54 55 56 |
# File 'lib/oci/core/models/instance_pool.rb', line 54 def @freeform_tags end |
#id ⇒ String
[Required] The OCID of the instance pool.
28 29 30 |
# File 'lib/oci/core/models/instance_pool.rb', line 28 def id @id end |
#instance_configuration_id ⇒ String
[Required] The OCID of the instance configuration associated with the instance pool.
60 61 62 |
# File 'lib/oci/core/models/instance_pool.rb', line 60 def instance_configuration_id @instance_configuration_id end |
#lifecycle_state ⇒ String
[Required] The current state of the instance pool.
64 65 66 |
# File 'lib/oci/core/models/instance_pool.rb', line 64 def lifecycle_state @lifecycle_state end |
#load_balancers ⇒ Array<OCI::Core::Models::InstancePoolLoadBalancerAttachment>
The load balancers attached to the instance pool.
83 84 85 |
# File 'lib/oci/core/models/instance_pool.rb', line 83 def load_balancers @load_balancers end |
#placement_configurations ⇒ Array<OCI::Core::Models::InstancePoolPlacementConfiguration>
[Required] The placement configurations for the instance pool.
68 69 70 |
# File 'lib/oci/core/models/instance_pool.rb', line 68 def placement_configurations @placement_configurations end |
#size ⇒ Integer
[Required] The number of instances that should be in the instance pool.
72 73 74 |
# File 'lib/oci/core/models/instance_pool.rb', line 72 def size @size end |
#time_created ⇒ DateTime
[Required] The date and time the instance pool was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
78 79 80 |
# File 'lib/oci/core/models/instance_pool.rb', line 78 def time_created @time_created end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 |
# File 'lib/oci/core/models/instance_pool.rb', line 86 def self.attribute_map { # rubocop:disable Style/SymbolLiteral 'id': :'id', 'compartment_id': :'compartmentId', 'defined_tags': :'definedTags', 'display_name': :'displayName', 'freeform_tags': :'freeformTags', 'instance_configuration_id': :'instanceConfigurationId', 'lifecycle_state': :'lifecycleState', 'placement_configurations': :'placementConfigurations', 'size': :'size', 'time_created': :'timeCreated', 'load_balancers': :'loadBalancers' # 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 |
# File 'lib/oci/core/models/instance_pool.rb', line 105 def self.swagger_types { # rubocop:disable Style/SymbolLiteral 'id': :'String', 'compartment_id': :'String', 'defined_tags': :'Hash<String, Hash<String, Object>>', 'display_name': :'String', 'freeform_tags': :'Hash<String, String>', 'instance_configuration_id': :'String', 'lifecycle_state': :'String', 'placement_configurations': :'Array<OCI::Core::Models::InstancePoolPlacementConfiguration>', 'size': :'Integer', 'time_created': :'DateTime', 'load_balancers': :'Array<OCI::Core::Models::InstancePoolLoadBalancerAttachment>' # rubocop:enable Style/SymbolLiteral } end |
Instance Method Details
#==(other) ⇒ Object
Checks equality by comparing each attribute.
225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 |
# File 'lib/oci/core/models/instance_pool.rb', line 225 def ==(other) return true if equal?(other) self.class == other.class && id == other.id && compartment_id == other.compartment_id && == other. && display_name == other.display_name && == other. && instance_configuration_id == other.instance_configuration_id && lifecycle_state == other.lifecycle_state && placement_configurations == other.placement_configurations && size == other.size && time_created == other.time_created && load_balancers == other.load_balancers end |
#build_from_hash(attributes) ⇒ Object
Builds the object from hash
265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 |
# File 'lib/oci/core/models/instance_pool.rb', line 265 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
245 246 247 |
# File 'lib/oci/core/models/instance_pool.rb', line 245 def eql?(other) self == other end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
254 255 256 |
# File 'lib/oci/core/models/instance_pool.rb', line 254 def hash [id, compartment_id, , display_name, , instance_configuration_id, lifecycle_state, placement_configurations, size, time_created, load_balancers].hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
298 299 300 301 302 303 304 305 306 307 |
# File 'lib/oci/core/models/instance_pool.rb', line 298 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
292 293 294 |
# File 'lib/oci/core/models/instance_pool.rb', line 292 def to_s to_hash.to_s end |