Class: OCI::Core::Models::InstancePoolSummary

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/core/models/instance_pool_summary.rb

Overview

Summary information for an instance pool.

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

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ InstancePoolSummary

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :id (String) —

    The value to assign to the #id property

  • :compartment_id (String) —

    The value to assign to the #compartment_id property

  • :display_name (String) —

    The value to assign to the #display_name property

  • :instance_configuration_id (String) —

    The value to assign to the #instance_configuration_id property

  • :pool_type (String) —

    The value to assign to the #pool_type property

  • :lifecycle_state (String) —

    The value to assign to the #lifecycle_state property

  • :availability_domains (Array<String>) —

    The value to assign to the #availability_domains property

  • :size (Integer) —

    The value to assign to the #size property

  • :time_created (DateTime) —

    The value to assign to the #time_created property

  • :defined_tags (Hash<String, Hash<String, Object>>) —

    The value to assign to the #defined_tags property

  • :freeform_tags (Hash<String, String>) —

    The value to assign to the #freeform_tags property

  • :current_size (Integer) —

    The value to assign to the #current_size property



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
204
205
206
207
208
209
210
211
212
 
# File 'lib/oci/core/models/instance_pool_summary.rb', line 143

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

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

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

  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.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.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.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

#availability_domains ⇒ Array<String>

[Required] The availability domains for the instance pool.

Returns:

  • (Array<String>) 


53
54
55
 
# File 'lib/oci/core/models/instance_pool_summary.rb', line 53

def availability_domains
  @availability_domains
end

#compartment_id ⇒ String

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

Returns:

  • (String) 


30
31
32
 
# File 'lib/oci/core/models/instance_pool_summary.rb', line 30

def compartment_id
  @compartment_id
end

#current_size ⇒ Integer

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

Returns:

  • (Integer) 


83
84
85
 
# File 'lib/oci/core/models/instance_pool_summary.rb', line 83

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>>) 


71
72
73
 
# File 'lib/oci/core/models/instance_pool_summary.rb', line 71

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) 


36
37
38
 
# File 'lib/oci/core/models/instance_pool_summary.rb', line 36

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>) 


79
80
81
 
# File 'lib/oci/core/models/instance_pool_summary.rb', line 79

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The OCID of the instance pool.

Returns:

  • (String) 


26
27
28
 
# File 'lib/oci/core/models/instance_pool_summary.rb', line 26

def id
  @id
end

#instance_configuration_id ⇒ String

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

Returns:

  • (String) 


40
41
42
 
# File 'lib/oci/core/models/instance_pool_summary.rb', line 40

def instance_configuration_id
  @instance_configuration_id
end

#lifecycle_state ⇒ String

[Required] The current state of the instance pool.

Returns:

  • (String) 


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

def lifecycle_state
  @lifecycle_state
end

#pool_type ⇒ String

The type of resources managed by the pool.

Returns:

  • (String) 


45
46
47
 
# File 'lib/oci/core/models/instance_pool_summary.rb', line 45

def pool_type
  @pool_type
end

#size ⇒ Integer

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

Returns:

  • (Integer) 


57
58
59
 
# File 'lib/oci/core/models/instance_pool_summary.rb', line 57

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) 


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

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
103
 
# File 'lib/oci/core/models/instance_pool_summary.rb', line 86

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'compartment_id': :'compartmentId',
    'display_name': :'displayName',
    'instance_configuration_id': :'instanceConfigurationId',
    'pool_type': :'poolType',
    'lifecycle_state': :'lifecycleState',
    'availability_domains': :'availabilityDomains',
    'size': :'size',
    'time_created': :'timeCreated',
    'defined_tags': :'definedTags',
    'freeform_tags': :'freeformTags',
    'current_size': :'currentSize'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
 
# File 'lib/oci/core/models/instance_pool_summary.rb', line 106

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'compartment_id': :'String',
    'display_name': :'String',
    'instance_configuration_id': :'String',
    'pool_type': :'String',
    'lifecycle_state': :'String',
    'availability_domains': :'Array<String>',
    'size': :'Integer',
    'time_created': :'DateTime',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'freeform_tags': :'Hash<String, String>',
    '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



234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
 
# File 'lib/oci/core/models/instance_pool_summary.rb', line 234

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

  self.class == other.class &&
    id == other.id &&
    compartment_id == other.compartment_id &&
    display_name == other.display_name &&
    instance_configuration_id == other.instance_configuration_id &&
    pool_type == other.pool_type &&
    lifecycle_state == other.lifecycle_state &&
    availability_domains == other.availability_domains &&
    size == other.size &&
    time_created == other.time_created &&
    defined_tags == other.defined_tags &&
    freeform_tags == other.freeform_tags &&
    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



275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
 
# File 'lib/oci/core/models/instance_pool_summary.rb', line 275

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


255
256
257
 
# File 'lib/oci/core/models/instance_pool_summary.rb', line 255

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



264
265
266
 
# File 'lib/oci/core/models/instance_pool_summary.rb', line 264

def hash
  [id, compartment_id, display_name, instance_configuration_id, pool_type, lifecycle_state, availability_domains, size, time_created, defined_tags, freeform_tags, 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



308
309
310
311
312
313
314
315
316
317
 
# File 'lib/oci/core/models/instance_pool_summary.rb', line 308

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



302
303
304
 
# File 'lib/oci/core/models/instance_pool_summary.rb', line 302

def to_s
  to_hash.to_s
end