class OCI::Limits::Models::LimitValueSummary

The value of a specific resource limit.

Constants

SCOPE_TYPE_ENUM

Attributes

availability_domain[RW]

If present, the returned value is only specific to this availability domain. @return [String]

name[RW]

The resource limit name. To be used for writing policies (in case of quotas) or other programmatic calls.

@return [String]

scope_type[R]

The scope type of the limit.

@return [String]

value[RW]

The resource limit value. @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/limit_value_summary.rb, line 37
def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'name': :'name',
    'scope_type': :'scopeType',
    'availability_domain': :'availabilityDomain',
    'value': :'value'
    # 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 [String] :name The value to assign to the {#name} property @option attributes [String] :scope_type The value to assign to the {#scope_type} property @option attributes [String] :availability_domain The value to assign to the {#availability_domain} property @option attributes [Integer] :value The value to assign to the {#value} property

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

  self.scope_type = attributes[:'scopeType'] if attributes[:'scopeType']

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

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

  self.availability_domain = attributes[:'availabilityDomain'] if attributes[:'availabilityDomain']

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

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

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

Attribute type mapping.

# File lib/oci/limits/models/limit_value_summary.rb, line 49
def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'name': :'String',
    'scope_type': :'String',
    'availability_domain': :'String',
    'value': :'Integer'
    # 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/limit_value_summary.rb, line 113
def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    name == other.name &&
    scope_type == other.scope_type &&
    availability_domain == other.availability_domain &&
    value == other.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/limit_value_summary.rb, line 146
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/limit_value_summary.rb, line 126
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/limit_value_summary.rb, line 135
def hash
  [name, scope_type, availability_domain, value].hash
end
scope_type=(scope_type) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] scope_type Object to be assigned

# File lib/oci/limits/models/limit_value_summary.rb, line 97
def scope_type=(scope_type)
  # rubocop:disable Style/ConditionalAssignment
  if scope_type && !SCOPE_TYPE_ENUM.include?(scope_type)
    OCI.logger.debug("Unknown value for 'scope_type' [" + scope_type + "]. Mapping to 'SCOPE_TYPE_UNKNOWN_ENUM_VALUE'") if OCI.logger
    @scope_type = SCOPE_TYPE_UNKNOWN_ENUM_VALUE
  else
    @scope_type = scope_type
  end
  # rubocop:enable Style/ConditionalAssignment
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/limit_value_summary.rb, line 179
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/limit_value_summary.rb, line 173
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/limit_value_summary.rb, line 196
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