Class: OCI::Limits::Models::LimitDefinitionSummary

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/limits/models/limit_definition_summary.rb

Overview

The metadata specific to a resource limit definition.

Constant Summary collapse

SCOPE_TYPE_ENUM = 
[
  SCOPE_TYPE_GLOBAL = 'GLOBAL'.freeze,
  SCOPE_TYPE_REGION = 'REGION'.freeze,
  SCOPE_TYPE_AD = 'AD'.freeze,
  SCOPE_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ LimitDefinitionSummary

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :name (String) —

    The value to assign to the #name property

  • :service_name (String) —

    The value to assign to the #service_name property

  • :description (String) —

    The value to assign to the #description property

  • :scope_type (String) —

    The value to assign to the #scope_type property

  • :are_quotas_supported (BOOLEAN) —

    The value to assign to the #are_quotas_supported property

  • :is_resource_availability_supported (BOOLEAN) —

    The value to assign to the #is_resource_availability_supported property

  • :is_deprecated (BOOLEAN) —

    The value to assign to the #is_deprecated property

  • :is_eligible_for_limit_increase (BOOLEAN) —

    The value to assign to the #is_eligible_for_limit_increase property

  • :is_dynamic (BOOLEAN) —

    The value to assign to the #is_dynamic property



111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
 
# 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

Instance Attribute Details

#are_quotas_supported ⇒ BOOLEAN

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

Returns:

  • (BOOLEAN) 


39
40
41
 
# File 'lib/oci/limits/models/limit_definition_summary.rb', line 39

def are_quotas_supported
  @are_quotas_supported
end

#description ⇒ String

The limit description.

Returns:

  • (String) 


29
30
31
 
# File 'lib/oci/limits/models/limit_definition_summary.rb', line 29

def description
  @description
end

#is_deprecated ⇒ BOOLEAN

Indicates if the limit has been deprecated.

Returns:

  • (BOOLEAN) 


50
51
52
 
# File 'lib/oci/limits/models/limit_definition_summary.rb', line 50

def is_deprecated
  @is_deprecated
end

#is_dynamic ⇒ BOOLEAN

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

Returns:

  • (BOOLEAN) 


60
61
62
 
# File 'lib/oci/limits/models/limit_definition_summary.rb', line 60

def is_dynamic
  @is_dynamic
end

#is_eligible_for_limit_increase ⇒ BOOLEAN

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

Returns:

  • (BOOLEAN) 


55
56
57
 
# File 'lib/oci/limits/models/limit_definition_summary.rb', line 55

def is_eligible_for_limit_increase
  @is_eligible_for_limit_increase
end

#is_resource_availability_supported ⇒ BOOLEAN

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

Returns:

  • (BOOLEAN) 


45
46
47
 
# File 'lib/oci/limits/models/limit_definition_summary.rb', line 45

def is_resource_availability_supported
  @is_resource_availability_supported
end

#name ⇒ String

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

Returns:

  • (String) 


21
22
23
 
# File 'lib/oci/limits/models/limit_definition_summary.rb', line 21

def name
  @name
end

#scope_type ⇒ String

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

Returns:

  • (String) 


34
35
36
 
# File 'lib/oci/limits/models/limit_definition_summary.rb', line 34

def scope_type
  @scope_type
end

#service_name ⇒ String

The service name of the limit.

Returns:

  • (String) 


25
26
27
 
# File 'lib/oci/limits/models/limit_definition_summary.rb', line 25

def service_name
  @service_name
end

Class Method Details

.attribute_map ⇒ Object

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



63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
 
# 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

.swagger_types ⇒ Object

Attribute type mapping.



80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
 
# 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

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other (Object) —

    the other object to be compared



184
185
186
187
188
189
190
191
192
193
194
195
196
197
 
# 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) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
 
# 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) ⇒ Boolean

Parameters:

  • other (Object) —

    the other object to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


202
203
204
 
# File 'lib/oci/limits/models/limit_definition_summary.rb', line 202

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



211
212
213
 
# 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

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



255
256
257
258
259
260
261
262
263
264
 
# 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 ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



249
250
251
 
# File 'lib/oci/limits/models/limit_definition_summary.rb', line 249

def to_s
  to_hash.to_s
end