class OCI::Limits::Models::LimitDefinitionSummary

The metadata specific to a resource limit definition.

Constants

SCOPE_TYPE_ENUM

Attributes

are_quotas_supported[RW]

If true, quota policies can be created on top of this resource limit.

@return [BOOLEAN]

description[RW]

The limit description. @return [String]

is_deprecated[RW]

Indicates if the limit has been deprecated.

@return [BOOLEAN]

is_dynamic[RW]

The limit for this resource has a dynamic value that is based on consumption across all OCI services.

@return [BOOLEAN]

is_eligible_for_limit_increase[RW]

Indicates if the customer can request a limit increase for this resource.

@return [BOOLEAN]

is_resource_availability_supported[RW]

Reflects whether or not the GetResourceAvailability API is supported for this limit. If not, the API returns an empty JSON response.

@return [BOOLEAN]

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]

Reflects the scope of the resource limit, whether Global (across all regions), regional, or availability domain-specific.

@return [String]

service_name[RW]

The service name of the limit. @return [String]

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_definition_summary.rb, line 63
def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'name': :'name',
    'service_name': :'serviceName',
    'description': :'description',
    'scope_type': :'scopeType',
    'are_quotas_supported': :'areQuotasSupported',
    'is_resource_availability_supported': :'isResourceAvailabilitySupported',
    'is_deprecated': :'isDeprecated',
    'is_eligible_for_limit_increase': :'isEligibleForLimitIncrease',
    'is_dynamic': :'isDynamic'
    # 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] :service_name The value to assign to the {#service_name} property @option attributes [String] :description The value to assign to the {#description} property @option attributes [String] :scope_type The value to assign to the {#scope_type} property @option attributes [BOOLEAN] :are_quotas_supported The value to assign to the {#are_quotas_supported} property @option attributes [BOOLEAN] :is_resource_availability_supported The value to assign to the {#is_resource_availability_supported} property @option attributes [BOOLEAN] :is_deprecated The value to assign to the {#is_deprecated} property @option attributes [BOOLEAN] :is_eligible_for_limit_increase The value to assign to the {#is_eligible_for_limit_increase} property @option attributes [BOOLEAN] :is_dynamic The value to assign to the {#is_dynamic} property

# File lib/oci/limits/models/limit_definition_summary.rb, line 111
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.service_name = attributes[:'serviceName'] if attributes[:'serviceName']

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

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

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

  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.are_quotas_supported = attributes[:'areQuotasSupported'] unless attributes[:'areQuotasSupported'].nil?

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

  self.are_quotas_supported = attributes[:'are_quotas_supported'] unless attributes[:'are_quotas_supported'].nil?

  self.is_resource_availability_supported = attributes[:'isResourceAvailabilitySupported'] unless attributes[:'isResourceAvailabilitySupported'].nil?

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

  self.is_resource_availability_supported = attributes[:'is_resource_availability_supported'] unless attributes[:'is_resource_availability_supported'].nil?

  self.is_deprecated = attributes[:'isDeprecated'] unless attributes[:'isDeprecated'].nil?

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

  self.is_deprecated = attributes[:'is_deprecated'] unless attributes[:'is_deprecated'].nil?

  self.is_eligible_for_limit_increase = attributes[:'isEligibleForLimitIncrease'] unless attributes[:'isEligibleForLimitIncrease'].nil?

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

  self.is_eligible_for_limit_increase = attributes[:'is_eligible_for_limit_increase'] unless attributes[:'is_eligible_for_limit_increase'].nil?

  self.is_dynamic = attributes[:'isDynamic'] unless attributes[:'isDynamic'].nil?

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

  self.is_dynamic = attributes[:'is_dynamic'] unless attributes[:'is_dynamic'].nil?
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/oci/limits/models/limit_definition_summary.rb, line 80
def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'name': :'String',
    'service_name': :'String',
    'description': :'String',
    'scope_type': :'String',
    'are_quotas_supported': :'BOOLEAN',
    'is_resource_availability_supported': :'BOOLEAN',
    'is_deprecated': :'BOOLEAN',
    'is_eligible_for_limit_increase': :'BOOLEAN',
    'is_dynamic': :'BOOLEAN'
    # 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_definition_summary.rb, line 184
def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    name == other.name &&
    service_name == other.service_name &&
    description == other.description &&
    scope_type == other.scope_type &&
    are_quotas_supported == other.are_quotas_supported &&
    is_resource_availability_supported == other.is_resource_availability_supported &&
    is_deprecated == other.is_deprecated &&
    is_eligible_for_limit_increase == other.is_eligible_for_limit_increase &&
    is_dynamic == other.is_dynamic
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_definition_summary.rb, line 222
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_definition_summary.rb, line 202
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_definition_summary.rb, line 211
def hash
  [name, service_name, description, scope_type, are_quotas_supported, is_resource_availability_supported, is_deprecated, is_eligible_for_limit_increase, is_dynamic].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_definition_summary.rb, line 168
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_definition_summary.rb, line 255
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_definition_summary.rb, line 249
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_definition_summary.rb, line 272
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