Class: OCI::Core::Models::CapacityReportShapeAvailability

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

Overview

Information about the available capacity for a shape.

Constant Summary collapse

AVAILABILITY_STATUS_ENUM = 
[
  AVAILABILITY_STATUS_OUT_OF_HOST_CAPACITY = 'OUT_OF_HOST_CAPACITY'.freeze,
  AVAILABILITY_STATUS_HARDWARE_NOT_SUPPORTED = 'HARDWARE_NOT_SUPPORTED'.freeze,
  AVAILABILITY_STATUS_AVAILABLE = 'AVAILABLE'.freeze,
  AVAILABILITY_STATUS_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CapacityReportShapeAvailability

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



80
81
82
83
84
85
86
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
 
# File 'lib/oci/core/models/capacity_report_shape_availability.rb', line 80

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

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

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

  self.availability_status = attributes[:'availabilityStatus'] if attributes[:'availabilityStatus']

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

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

Instance Attribute Details

#availability_status ⇒ String

A flag denoting whether capacity is available.

Returns:

  • (String) 


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

def availability_status
  @availability_status
end

#available_count ⇒ Integer

The total number of new instances that can be created with the specified shape configuration.

Returns:

  • (Integer) 


37
38
39
 
# File 'lib/oci/core/models/capacity_report_shape_availability.rb', line 37

def available_count
  @available_count
end

#fault_domain ⇒ String

The fault domain for the capacity report.

If you do not specify the fault domain, the capacity report includes information about all fault domains.

Returns:

  • (String) 


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

def fault_domain
  @fault_domain
end

#instance_shape ⇒ String

The shape that the capacity report was requested for.

Returns:

  • (String) 


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

def instance_shape
  @instance_shape
end

#instance_shape_config ⇒ OCI::Core::Models::CapacityReportInstanceShapeConfig

Returns:



33
34
35
 
# File 'lib/oci/core/models/capacity_report_shape_availability.rb', line 33

def instance_shape_config
  @instance_shape_config
end

Class Method Details

.attribute_map ⇒ Object

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



44
45
46
47
48
49
50
51
52
53
54
 
# File 'lib/oci/core/models/capacity_report_shape_availability.rb', line 44

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'fault_domain': :'faultDomain',
    'instance_shape': :'instanceShape',
    'instance_shape_config': :'instanceShapeConfig',
    'available_count': :'availableCount',
    'availability_status': :'availabilityStatus'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



57
58
59
60
61
62
63
64
65
66
67
 
# File 'lib/oci/core/models/capacity_report_shape_availability.rb', line 57

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'fault_domain': :'String',
    'instance_shape': :'String',
    'instance_shape_config': :'OCI::Core::Models::CapacityReportInstanceShapeConfig',
    'available_count': :'Integer',
    'availability_status': :'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



137
138
139
140
141
142
143
144
145
146
 
# File 'lib/oci/core/models/capacity_report_shape_availability.rb', line 137

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

  self.class == other.class &&
    fault_domain == other.fault_domain &&
    instance_shape == other.instance_shape &&
    instance_shape_config == other.instance_shape_config &&
    available_count == other.available_count &&
    availability_status == other.availability_status
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



171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
 
# File 'lib/oci/core/models/capacity_report_shape_availability.rb', line 171

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


151
152
153
 
# File 'lib/oci/core/models/capacity_report_shape_availability.rb', line 151

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



160
161
162
 
# File 'lib/oci/core/models/capacity_report_shape_availability.rb', line 160

def hash
  [fault_domain, instance_shape, instance_shape_config, available_count, availability_status].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



204
205
206
207
208
209
210
211
212
213
 
# File 'lib/oci/core/models/capacity_report_shape_availability.rb', line 204

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



198
199
200
 
# File 'lib/oci/core/models/capacity_report_shape_availability.rb', line 198

def to_s
  to_hash.to_s
end