class OCI::Limits::Models::ResourceAvailability

The availability of a given resource limit, based on the usage, tenant service limits, and quotas set for the tenancy. Note: We cannot guarantee this data for all the limits. In such cases, these fields will be empty.

Attributes

available[RW]

The count of available resources. To support resources with fractional counts, the field rounds down to the nearest integer.

@return [Integer]

effective_quota_value[RW]

The effective quota value for the given compartment. This field is only present if there is a current quota policy affecting the current resource in the target region or availability domain.

@return [Float]

fractional_availability[RW]

The most accurate count of available resources.

@return [Float]

fractional_usage[RW]

The current most accurate usage in the given compartment.

@return [Float]

used[RW]

The current usage in the given compartment. To support resources with fractional counts, the field rounds up to the nearest integer.

@return [Integer]

Public Class Methods

attribute_map() click to toggle source

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

# File lib/oci/limits/models/resource_availability.rb, line 41
def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'used': :'used',
    'available': :'available',
    'fractional_usage': :'fractionalUsage',
    'fractional_availability': :'fractionalAvailability',
    'effective_quota_value': :'effectiveQuotaValue'
    # rubocop:enable Style/SymbolLiteral
  }
end
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash @option attributes [Integer] :used The value to assign to the {#used} property @option attributes [Integer] :available The value to assign to the {#available} property @option attributes [Float] :fractional_usage The value to assign to the {#fractional_usage} property @option attributes [Float] :fractional_availability The value to assign to the {#fractional_availability} property @option attributes [Float] :effective_quota_value The value to assign to the {#effective_quota_value} property

# File lib/oci/limits/models/resource_availability.rb, line 77
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.used = attributes[:'used'] if attributes[:'used']

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

  self.fractional_usage = attributes[:'fractionalUsage'] if attributes[:'fractionalUsage']

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

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

  self.fractional_availability = attributes[:'fractionalAvailability'] if attributes[:'fractionalAvailability']

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

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

  self.effective_quota_value = attributes[:'effectiveQuotaValue'] if attributes[:'effectiveQuotaValue']

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

  self.effective_quota_value = attributes[:'effective_quota_value'] if attributes[:'effective_quota_value']
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/oci/limits/models/resource_availability.rb, line 54
def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'used': :'Integer',
    'available': :'Integer',
    'fractional_usage': :'Float',
    'fractional_availability': :'Float',
    'effective_quota_value': :'Float'
    # rubocop:enable Style/SymbolLiteral
  }
end

Public Instance Methods

==(other) click to toggle source

Checks equality by comparing each attribute. @param [Object] other the other object to be compared

# File lib/oci/limits/models/resource_availability.rb, line 113
def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    used == other.used &&
    available == other.available &&
    fractional_usage == other.fractional_usage &&
    fractional_availability == other.fractional_availability &&
    effective_quota_value == other.effective_quota_value
end
build_from_hash(attributes) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/oci/limits/models/resource_availability.rb, line 147
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) click to toggle source

@see the `==` method @param [Object] other the other object to be compared

# File lib/oci/limits/models/resource_availability.rb, line 127
def eql?(other)
  self == other
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Fixnum] Hash code

# File lib/oci/limits/models/resource_availability.rb, line 136
def hash
  [used, available, fractional_usage, fractional_availability, effective_quota_value].hash
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# File lib/oci/limits/models/resource_availability.rb, line 180
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() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/oci/limits/models/resource_availability.rb, line 174
def to_s
  to_hash.to_s
end

Private Instance Methods

_to_hash(value) click to toggle source

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash

# File lib/oci/limits/models/resource_availability.rb, line 197
def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end