Class: OCI::Core::Models::InstancePool

Inherits:
Object
  • Object
show all
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

POOL_TYPE_ENUM = 
[
  POOL_TYPE_INSTANCE = 'INSTANCE'.freeze,
  POOL_TYPE_GMC = 'GMC'.freeze,
  POOL_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
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

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ InstancePool

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
 
# File 'lib/oci/core/models/instance_pool.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.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.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']

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

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

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

  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']

  self.lifecycle_management = attributes[:'lifecycleManagement'] if attributes[:'lifecycleManagement']

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

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

  self.current_size = attributes[:'currentSize'] if attributes[:'currentSize']

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

  self.current_size = attributes[:'current_size'] if attributes[:'current_size']
end

Instance Attribute Details

#compartment_id ⇒ String

[Required] The OCID of the compartment containing the instance pool.

Returns:

  • (String) 


41
42
43
 
# File 'lib/oci/core/models/instance_pool.rb', line 41

def compartment_id
  @compartment_id
end

#current_size ⇒ Integer

Count of instance in running state associated to the Instance Pool.

Returns:

  • (Integer) 


116
117
118
 
# File 'lib/oci/core/models/instance_pool.rb', line 116

def current_size
  @current_size
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\"}}

Returns:

  • (Hash<String, Hash<String, Object>>) 


49
50
51
 
# File 'lib/oci/core/models/instance_pool.rb', line 49

def defined_tags
  @defined_tags
end

#display_name ⇒ String

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

Returns:

  • (String) 


55
56
57
 
# File 'lib/oci/core/models/instance_pool.rb', line 55

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\"}

Returns:

  • (Hash<String, String>) 


63
64
65
 
# File 'lib/oci/core/models/instance_pool.rb', line 63

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The OCID of the instance pool.

Returns:

  • (String) 


35
36
37
 
# File 'lib/oci/core/models/instance_pool.rb', line 35

def id
  @id
end

#instance_configuration_id ⇒ String

[Required] The OCID of the instance configuration associated with the instance pool.

Returns:

  • (String) 


69
70
71
 
# File 'lib/oci/core/models/instance_pool.rb', line 69

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

Returns:

  • (String) 


103
104
105
 
# File 'lib/oci/core/models/instance_pool.rb', line 103

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

Returns:

  • (String) 


109
110
111
 
# File 'lib/oci/core/models/instance_pool.rb', line 109

def instance_hostname_formatter
  @instance_hostname_formatter
end

#lifecycle_management ⇒ OCI::Core::Models::InstancePoolLifecycleManagementDetails

Returns:



112
113
114
 
# File 'lib/oci/core/models/instance_pool.rb', line 112

def lifecycle_management
  @lifecycle_management
end

#lifecycle_state ⇒ String

[Required] The current state of the instance pool.

Returns:

  • (String) 


78
79
80
 
# File 'lib/oci/core/models/instance_pool.rb', line 78

def lifecycle_state
  @lifecycle_state
end

#load_balancers ⇒ Array<OCI::Core::Models::InstancePoolLoadBalancerAttachment>

The load balancers attached to the instance pool.

Returns:



97
98
99
 
# File 'lib/oci/core/models/instance_pool.rb', line 97

def load_balancers
  @load_balancers
end

#placement_configurations ⇒ Array<OCI::Core::Models::InstancePoolPlacementConfiguration>

[Required] The placement configurations for the instance pool.

Returns:



82
83
84
 
# File 'lib/oci/core/models/instance_pool.rb', line 82

def placement_configurations
  @placement_configurations
end

#pool_type ⇒ String

The type of resources managed by the pool.

Returns:

  • (String) 


74
75
76
 
# File 'lib/oci/core/models/instance_pool.rb', line 74

def pool_type
  @pool_type
end

#size ⇒ Integer

[Required] The number of instances that should be in the instance pool.

Returns:

  • (Integer) 


86
87
88
 
# File 'lib/oci/core/models/instance_pool.rb', line 86

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

Returns:

  • (DateTime) 


92
93
94
 
# File 'lib/oci/core/models/instance_pool.rb', line 92

def time_created
  @time_created
end

Class Method Details

.attribute_map ⇒ Object

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



119
120
121
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 119

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',
    'pool_type': :'poolType',
    'lifecycle_state': :'lifecycleState',
    'placement_configurations': :'placementConfigurations',
    'size': :'size',
    'time_created': :'timeCreated',
    'load_balancers': :'loadBalancers',
    'instance_display_name_formatter': :'instanceDisplayNameFormatter',
    'instance_hostname_formatter': :'instanceHostnameFormatter',
    'lifecycle_management': :'lifecycleManagement',
    'current_size': :'currentSize'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
 
# File 'lib/oci/core/models/instance_pool.rb', line 143

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',
    'pool_type': :'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',
    'lifecycle_management': :'OCI::Core::Models::InstancePoolLifecycleManagementDetails',
    'current_size': :'Integer'
    # 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



316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
 
# File 'lib/oci/core/models/instance_pool.rb', line 316

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

  self.class == other.class &&
    id == other.id &&
    compartment_id == other.compartment_id &&
    defined_tags == other.defined_tags &&
    display_name == other.display_name &&
    freeform_tags == other.freeform_tags &&
    instance_configuration_id == other.instance_configuration_id &&
    pool_type == other.pool_type &&
    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 &&
    lifecycle_management == other.lifecycle_management &&
    current_size == other.current_size
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



361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
 
# File 'lib/oci/core/models/instance_pool.rb', line 361

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


341
342
343
 
# File 'lib/oci/core/models/instance_pool.rb', line 341

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



350
351
352
 
# File 'lib/oci/core/models/instance_pool.rb', line 350

def hash
  [id, compartment_id, defined_tags, display_name, freeform_tags, instance_configuration_id, pool_type, lifecycle_state, placement_configurations, size, time_created, load_balancers, instance_display_name_formatter, instance_hostname_formatter, lifecycle_management, current_size].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



394
395
396
397
398
399
400
401
402
403
 
# File 'lib/oci/core/models/instance_pool.rb', line 394

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



388
389
390
 
# File 'lib/oci/core/models/instance_pool.rb', line 388

def to_s
  to_hash.to_s
end