Class: OCI::Core::Models::InstanceReservationConfig

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

Overview

Data that defines the capacity configuration.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ InstanceReservationConfig

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
 
# File 'lib/oci/core/models/instance_reservation_config.rb', line 87

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

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

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

  self.cluster_config = attributes[:'clusterConfig'] if attributes[:'clusterConfig']

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

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

  self.instance_shape = attributes[:'instanceShape'] if attributes[:'instanceShape']

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

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

  self.instance_shape_config = attributes[:'instanceShapeConfig'] if attributes[:'instanceShapeConfig']

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

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

  self.reserved_count = attributes[:'reservedCount'] if attributes[:'reservedCount']

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

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

  self.used_count = attributes[:'usedCount'] if attributes[:'usedCount']

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

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

  self.cluster_placement_group_id = attributes[:'clusterPlacementGroupId'] if attributes[:'clusterPlacementGroupId']

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

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

Instance Attribute Details

#cluster_config ⇒ OCI::Core::Models::ClusterConfigDetails

Returns:



20
21
22
 
# File 'lib/oci/core/models/instance_reservation_config.rb', line 20

def cluster_config
  @cluster_config
end

#cluster_placement_group_id ⇒ String

The OCID of the cluster placement group for this instance reservation capacity configuration.

Returns:

  • (String) 


42
43
44
 
# File 'lib/oci/core/models/instance_reservation_config.rb', line 42

def cluster_placement_group_id
  @cluster_placement_group_id
end

#fault_domain ⇒ String

The fault domain of this capacity configuration. If a value is not supplied, this capacity configuration is applicable to all fault domains in the specified availability domain. For more information, see Capacity Reservations.

Returns:

  • (String) 


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

def fault_domain
  @fault_domain
end

#instance_shape ⇒ String

[Required] The shape to use when launching instances using compute capacity reservations. The shape determines the number of CPUs, the amount of memory, and other resources allocated to the instance. You can list all available shapes by calling ListComputeCapacityReservationInstanceShapes.

Returns:

  • (String) 


27
28
29
 
# File 'lib/oci/core/models/instance_reservation_config.rb', line 27

def instance_shape
  @instance_shape
end

#instance_shape_config ⇒ OCI::Core::Models::InstanceReservationShapeConfigDetails

Returns:



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

def instance_shape_config
  @instance_shape_config
end

#reserved_count ⇒ Integer

[Required] The total number of instances that can be launched from the capacity configuration.

Returns:

  • (Integer) 


34
35
36
 
# File 'lib/oci/core/models/instance_reservation_config.rb', line 34

def reserved_count
  @reserved_count
end

#used_count ⇒ Integer

[Required] The amount of capacity in use out of the total capacity reserved in this capacity configuration.

Returns:

  • (Integer) 


38
39
40
 
# File 'lib/oci/core/models/instance_reservation_config.rb', line 38

def used_count
  @used_count
end

Class Method Details

.attribute_map ⇒ Object

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



45
46
47
48
49
50
51
52
53
54
55
56
57
 
# File 'lib/oci/core/models/instance_reservation_config.rb', line 45

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'fault_domain': :'faultDomain',
    'cluster_config': :'clusterConfig',
    'instance_shape': :'instanceShape',
    'instance_shape_config': :'instanceShapeConfig',
    'reserved_count': :'reservedCount',
    'used_count': :'usedCount',
    'cluster_placement_group_id': :'clusterPlacementGroupId'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



60
61
62
63
64
65
66
67
68
69
70
71
72
 
# File 'lib/oci/core/models/instance_reservation_config.rb', line 60

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'fault_domain': :'String',
    'cluster_config': :'OCI::Core::Models::ClusterConfigDetails',
    'instance_shape': :'String',
    'instance_shape_config': :'OCI::Core::Models::InstanceReservationShapeConfigDetails',
    'reserved_count': :'Integer',
    'used_count': :'Integer',
    'cluster_placement_group_id': :'String'
    # 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



143
144
145
146
147
148
149
150
151
152
153
154
 
# File 'lib/oci/core/models/instance_reservation_config.rb', line 143

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

  self.class == other.class &&
    fault_domain == other.fault_domain &&
    cluster_config == other.cluster_config &&
    instance_shape == other.instance_shape &&
    instance_shape_config == other.instance_shape_config &&
    reserved_count == other.reserved_count &&
    used_count == other.used_count &&
    cluster_placement_group_id == other.cluster_placement_group_id
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



179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
 
# File 'lib/oci/core/models/instance_reservation_config.rb', line 179

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


159
160
161
 
# File 'lib/oci/core/models/instance_reservation_config.rb', line 159

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



168
169
170
 
# File 'lib/oci/core/models/instance_reservation_config.rb', line 168

def hash
  [fault_domain, cluster_config, instance_shape, instance_shape_config, reserved_count, used_count, cluster_placement_group_id].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



212
213
214
215
216
217
218
219
220
221
 
# File 'lib/oci/core/models/instance_reservation_config.rb', line 212

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



206
207
208
 
# File 'lib/oci/core/models/instance_reservation_config.rb', line 206

def to_s
  to_hash.to_s
end