Class: OCI::Core::Models::CreateInstancePoolDetails

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

Overview

The data to create an instance pool. For a GMC-enabled resource pool, the referenced instance configuration must be a GMC configuration and the placement configuration must identify the availability domain and compute cluster for the pool.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateInstancePoolDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



139
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
204
205
206
 
# File 'lib/oci/core/models/create_instance_pool_details.rb', line 139

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

Instance Attribute Details

#compartment_id ⇒ String

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

Returns:

  • (String) 


17
18
19
 
# File 'lib/oci/core/models/create_instance_pool_details.rb', line 17

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

Returns:

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


25
26
27
 
# File 'lib/oci/core/models/create_instance_pool_details.rb', line 25

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) 


31
32
33
 
# File 'lib/oci/core/models/create_instance_pool_details.rb', line 31

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


39
40
41
 
# File 'lib/oci/core/models/create_instance_pool_details.rb', line 39

def freeform_tags
  @freeform_tags
end

#instance_configuration_id ⇒ String

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

Returns:

  • (String) 


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

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) 


73
74
75
 
# File 'lib/oci/core/models/create_instance_pool_details.rb', line 73

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) 


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

def instance_hostname_formatter
  @instance_hostname_formatter
end

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

Returns:



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

def lifecycle_management
  @lifecycle_management
end

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

The load balancers to attach to the instance pool.

Returns:



67
68
69
 
# File 'lib/oci/core/models/create_instance_pool_details.rb', line 67

def load_balancers
  @load_balancers
end

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

[Required] The placement configurations for the instance pool. Provide one placement configuration for each availability domain.

To use the instance pool with a regional subnet, provide a placement configuration for each availability domain, and include the regional subnet in each placement configuration. To use compute cluster with instance pool, provide a single placement configuration.

Returns:



56
57
58
 
# File 'lib/oci/core/models/create_instance_pool_details.rb', line 56

def placement_configurations
  @placement_configurations
end

#size ⇒ Integer

[Required] The number of instances that should be in the instance pool. For a GMC-enabled resource pool, this is the number of GMC resources that should be in the pool.

Returns:

  • (Integer) 


62
63
64
 
# File 'lib/oci/core/models/create_instance_pool_details.rb', line 62

def size
  @size
end

Class Method Details

.attribute_map ⇒ Object

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



85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
 
# File 'lib/oci/core/models/create_instance_pool_details.rb', line 85

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'compartment_id': :'compartmentId',
    'defined_tags': :'definedTags',
    'display_name': :'displayName',
    'freeform_tags': :'freeformTags',
    'instance_configuration_id': :'instanceConfigurationId',
    'placement_configurations': :'placementConfigurations',
    'size': :'size',
    'load_balancers': :'loadBalancers',
    'instance_display_name_formatter': :'instanceDisplayNameFormatter',
    'instance_hostname_formatter': :'instanceHostnameFormatter',
    'lifecycle_management': :'lifecycleManagement'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
 
# File 'lib/oci/core/models/create_instance_pool_details.rb', line 104

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'compartment_id': :'String',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'display_name': :'String',
    'freeform_tags': :'Hash<String, String>',
    'instance_configuration_id': :'String',
    'placement_configurations': :'Array<OCI::Core::Models::CreateInstancePoolPlacementConfigurationDetails>',
    'size': :'Integer',
    'load_balancers': :'Array<OCI::Core::Models::AttachLoadBalancerDetails>',
    'instance_display_name_formatter': :'String',
    'instance_hostname_formatter': :'String',
    'lifecycle_management': :'OCI::Core::Models::InstancePoolLifecycleManagementDetails'
    # 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



215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
 
# File 'lib/oci/core/models/create_instance_pool_details.rb', line 215

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

  self.class == other.class &&
    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 &&
    placement_configurations == other.placement_configurations &&
    size == other.size &&
    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
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



255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
 
# File 'lib/oci/core/models/create_instance_pool_details.rb', line 255

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


235
236
237
 
# File 'lib/oci/core/models/create_instance_pool_details.rb', line 235

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



244
245
246
 
# File 'lib/oci/core/models/create_instance_pool_details.rb', line 244

def hash
  [compartment_id, defined_tags, display_name, freeform_tags, instance_configuration_id, placement_configurations, size, load_balancers, instance_display_name_formatter, instance_hostname_formatter, lifecycle_management].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



288
289
290
291
292
293
294
295
296
297
 
# File 'lib/oci/core/models/create_instance_pool_details.rb', line 288

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



282
283
284
 
# File 'lib/oci/core/models/create_instance_pool_details.rb', line 282

def to_s
  to_hash.to_s
end