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 set of instances within the same region that are managed as a group. 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
A 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.
-
#instance_display_name_formatter ⇒ String
A user-friendly formatter for the instance pool's instances.
-
#instance_hostname_formatter ⇒ String
A user-friendly formatter for the instance pool's instances.
-
#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
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 |
# File 'lib/oci/core/models/instance_pool.rb', line 161 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'] self.instance_display_name_formatter = attributes[:'instanceDisplayNameFormatter'] if attributes[:'instanceDisplayNameFormatter'] raise 'You cannot provide both :instanceDisplayNameFormatter and :instance_display_name_formatter' if attributes.key?(:'instanceDisplayNameFormatter') && attributes.key?(:'instance_display_name_formatter') self.instance_display_name_formatter = attributes[:'instance_display_name_formatter'] if attributes[:'instance_display_name_formatter'] self.instance_hostname_formatter = attributes[:'instanceHostnameFormatter'] if attributes[:'instanceHostnameFormatter'] raise 'You cannot provide both :instanceHostnameFormatter and :instance_hostname_formatter' if attributes.key?(:'instanceHostnameFormatter') && attributes.key?(:'instance_hostname_formatter') self.instance_hostname_formatter = attributes[:'instance_hostname_formatter'] if attributes[:'instance_hostname_formatter'] end |
Instance Attribute Details
#compartment_id ⇒ String
[Required] The OCID of the compartment containing the instance pool.
35 36 37 |
# File 'lib/oci/core/models/instance_pool.rb', line 35 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\"}}
43 44 45 |
# File 'lib/oci/core/models/instance_pool.rb', line 43 def @defined_tags end |
#display_name ⇒ String
A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
49 50 51 |
# File 'lib/oci/core/models/instance_pool.rb', line 49 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\"}
57 58 59 |
# File 'lib/oci/core/models/instance_pool.rb', line 57 def @freeform_tags end |
#id ⇒ String
[Required] The OCID of the instance pool.
29 30 31 |
# File 'lib/oci/core/models/instance_pool.rb', line 29 def id @id end |
#instance_configuration_id ⇒ String
[Required] The OCID of the instance configuration associated with the instance pool.
63 64 65 |
# File 'lib/oci/core/models/instance_pool.rb', line 63 def instance_configuration_id @instance_configuration_id end |
#instance_display_name_formatter ⇒ String
A user-friendly formatter for the instance pool's instances. Instance displaynames follow the format. The formatter does not retroactively change instance's displaynames, only instance displaynames in the future follow the format
92 93 94 |
# File 'lib/oci/core/models/instance_pool.rb', line 92 def instance_display_name_formatter @instance_display_name_formatter end |
#instance_hostname_formatter ⇒ String
A user-friendly formatter for the instance pool's instances. Instance hostnames follow the format. The formatter does not retroactively change instance's hostnames, only instance hostnames in the future follow the format
98 99 100 |
# File 'lib/oci/core/models/instance_pool.rb', line 98 def instance_hostname_formatter @instance_hostname_formatter end |
#lifecycle_state ⇒ String
[Required] The current state of the instance pool.
67 68 69 |
# File 'lib/oci/core/models/instance_pool.rb', line 67 def lifecycle_state @lifecycle_state end |
#load_balancers ⇒ Array<OCI::Core::Models::InstancePoolLoadBalancerAttachment>
The load balancers attached to the instance pool.
86 87 88 |
# File 'lib/oci/core/models/instance_pool.rb', line 86 def load_balancers @load_balancers end |
#placement_configurations ⇒ Array<OCI::Core::Models::InstancePoolPlacementConfiguration>
[Required] The placement configurations for the instance pool.
71 72 73 |
# File 'lib/oci/core/models/instance_pool.rb', line 71 def placement_configurations @placement_configurations end |
#size ⇒ Integer
[Required] The number of instances that should be in the instance pool.
75 76 77 |
# File 'lib/oci/core/models/instance_pool.rb', line 75 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
81 82 83 |
# File 'lib/oci/core/models/instance_pool.rb', line 81 def time_created @time_created end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 |
# File 'lib/oci/core/models/instance_pool.rb', line 101 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', 'instance_display_name_formatter': :'instanceDisplayNameFormatter', 'instance_hostname_formatter': :'instanceHostnameFormatter' # rubocop:enable Style/SymbolLiteral } end |
.swagger_types ⇒ Object
Attribute type mapping.
122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 |
# File 'lib/oci/core/models/instance_pool.rb', line 122 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>', 'instance_display_name_formatter': :'String', 'instance_hostname_formatter': :'String' # rubocop:enable Style/SymbolLiteral } end |
Instance Method Details
#==(other) ⇒ Object
Checks equality by comparing each attribute.
258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 |
# File 'lib/oci/core/models/instance_pool.rb', line 258 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 && instance_display_name_formatter == other.instance_display_name_formatter && instance_hostname_formatter == other.instance_hostname_formatter end |
#build_from_hash(attributes) ⇒ Object
Builds the object from hash
300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 |
# File 'lib/oci/core/models/instance_pool.rb', line 300 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
280 281 282 |
# File 'lib/oci/core/models/instance_pool.rb', line 280 def eql?(other) self == other end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
289 290 291 |
# File 'lib/oci/core/models/instance_pool.rb', line 289 def hash [id, compartment_id, , display_name, , instance_configuration_id, lifecycle_state, placement_configurations, size, time_created, load_balancers, instance_display_name_formatter, instance_hostname_formatter].hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
333 334 335 336 337 338 339 340 341 342 |
# File 'lib/oci/core/models/instance_pool.rb', line 333 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
327 328 329 |
# File 'lib/oci/core/models/instance_pool.rb', line 327 def to_s to_hash.to_s end |