Class: OCI::Limits::Models::Quota
- Inherits:
-
Object
- Object
- OCI::Limits::Models::Quota
- Defined in:
- lib/oci/limits/models/quota.rb
Overview
Quotas are applied on top of the service limits and inherited through the nested compartment hierarchy. Quotas allow compartment admins to limit resource consumption and set boundaries around acceptable resource use. The term "quota" can be interpreted as the following: * An individual statement written in the declarative language. * A collection of statements in a single, named "quota" object (which has an Oracle Cloud ID (OCID) assigned to it). * The overall body of quotas your organization uses to control access to resources.
Constant Summary collapse
- LIFECYCLE_STATE_ENUM =
[ LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze, LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze ].freeze
Instance Attribute Summary collapse
-
#compartment_id ⇒ String
[Required] The OCID of the compartment containing the resource this quota applies to.
-
#defined_tags ⇒ Hash<String, Hash<String, Object>>
Defined tags for this resource.
-
#description ⇒ String
[Required] The description you assign to the quota.
-
#freeform_tags ⇒ Hash<String, String>
Free-form tags for this resource.
-
#id ⇒ String
[Required] The OCID of the quota.
-
#lifecycle_state ⇒ String
The quota's current state.
-
#locks ⇒ Array<OCI::Limits::Models::ResourceLock>
Locks associated with this resource.
-
#name ⇒ String
[Required] The name you assign to the quota during creation.
-
#statements ⇒ Array<String>
[Required] An array of one or more quota statements written in the declarative quota statement language.
-
#time_created ⇒ DateTime
[Required] Date and time the quota was created, in the format defined by RFC 3339.
Class Method Summary collapse
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.swagger_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(other) ⇒ Object
Checks equality by comparing each attribute.
-
#build_from_hash(attributes) ⇒ Object
Builds the object from hash.
- #eql?(other) ⇒ Boolean
-
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ Quota
constructor
Initializes the object.
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
Constructor Details
#initialize(attributes = {}) ⇒ Quota
Initializes the object
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 163 164 165 166 167 168 169 170 171 172 173 |
# File 'lib/oci/limits/models/quota.rb', line 128 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.id = attributes[:'id'] if attributes[:'id'] self.compartment_id = attributes[:'compartmentId'] if attributes[:'compartmentId'] raise 'You cannot provide both :compartmentId and :compartment_id' if attributes.key?(:'compartmentId') && attributes.key?(:'compartment_id') self.compartment_id = attributes[:'compartment_id'] if attributes[:'compartment_id'] self.name = attributes[:'name'] if attributes[:'name'] self.statements = attributes[:'statements'] if attributes[:'statements'] self.locks = attributes[:'locks'] if attributes[:'locks'] self.description = attributes[:'description'] if attributes[:'description'] self.time_created = attributes[:'timeCreated'] if attributes[:'timeCreated'] raise 'You cannot provide both :timeCreated and :time_created' if attributes.key?(:'timeCreated') && attributes.key?(:'time_created') self.time_created = attributes[:'time_created'] if attributes[:'time_created'] self.lifecycle_state = attributes[:'lifecycleState'] if attributes[:'lifecycleState'] raise 'You cannot provide both :lifecycleState and :lifecycle_state' if attributes.key?(:'lifecycleState') && attributes.key?(:'lifecycle_state') self.lifecycle_state = attributes[:'lifecycle_state'] if attributes[:'lifecycle_state'] self. = attributes[:'freeformTags'] if attributes[:'freeformTags'] raise 'You cannot provide both :freeformTags and :freeform_tags' if attributes.key?(:'freeformTags') && attributes.key?(:'freeform_tags') self. = attributes[:'freeform_tags'] if attributes[:'freeform_tags'] self. = attributes[:'definedTags'] if attributes[:'definedTags'] raise 'You cannot provide both :definedTags and :defined_tags' if attributes.key?(:'definedTags') && attributes.key?(:'defined_tags') self. = attributes[:'defined_tags'] if attributes[:'defined_tags'] end |
Instance Attribute Details
#compartment_id ⇒ String
[Required] The OCID of the compartment containing the resource this quota applies to.
30 31 32 |
# File 'lib/oci/limits/models/quota.rb', line 30 def compartment_id @compartment_id end |
#defined_tags ⇒ Hash<String, Hash<String, Object>>
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {\"Operations\": {\"CostCenter\": \"42\"}}
74 75 76 |
# File 'lib/oci/limits/models/quota.rb', line 74 def @defined_tags end |
#description ⇒ String
[Required] The description you assign to the quota.
48 49 50 |
# File 'lib/oci/limits/models/quota.rb', line 48 def description @description end |
#freeform_tags ⇒ Hash<String, String>
Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {\"Department\": \"Finance\"}
67 68 69 |
# File 'lib/oci/limits/models/quota.rb', line 67 def @freeform_tags end |
#id ⇒ String
[Required] The OCID of the quota.
25 26 27 |
# File 'lib/oci/limits/models/quota.rb', line 25 def id @id end |
#lifecycle_state ⇒ String
The quota's current state. After creating a quota, make sure its lifecycleState
is set to ACTIVE before using it.
60 61 62 |
# File 'lib/oci/limits/models/quota.rb', line 60 def lifecycle_state @lifecycle_state end |
#locks ⇒ Array<OCI::Limits::Models::ResourceLock>
Locks associated with this resource.
44 45 46 |
# File 'lib/oci/limits/models/quota.rb', line 44 def locks @locks end |
#name ⇒ String
[Required] The name you assign to the quota during creation. The name must be unique across all quotas in the tenancy and cannot be changed.
36 37 38 |
# File 'lib/oci/limits/models/quota.rb', line 36 def name @name end |
#statements ⇒ Array<String>
[Required] An array of one or more quota statements written in the declarative quota statement language.
40 41 42 |
# File 'lib/oci/limits/models/quota.rb', line 40 def statements @statements end |
#time_created ⇒ DateTime
[Required] Date and time the quota was created, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
54 55 56 |
# File 'lib/oci/limits/models/quota.rb', line 54 def time_created @time_created end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 |
# File 'lib/oci/limits/models/quota.rb', line 77 def self.attribute_map { # rubocop:disable Style/SymbolLiteral 'id': :'id', 'compartment_id': :'compartmentId', 'name': :'name', 'statements': :'statements', 'locks': :'locks', 'description': :'description', 'time_created': :'timeCreated', 'lifecycle_state': :'lifecycleState', 'freeform_tags': :'freeformTags', 'defined_tags': :'definedTags' # rubocop:enable Style/SymbolLiteral } end |
.swagger_types ⇒ Object
Attribute type mapping.
95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 |
# File 'lib/oci/limits/models/quota.rb', line 95 def self.swagger_types { # rubocop:disable Style/SymbolLiteral 'id': :'String', 'compartment_id': :'String', 'name': :'String', 'statements': :'Array<String>', 'locks': :'Array<OCI::Limits::Models::ResourceLock>', 'description': :'String', 'time_created': :'DateTime', 'lifecycle_state': :'String', 'freeform_tags': :'Hash<String, String>', 'defined_tags': :'Hash<String, Hash<String, Object>>' # rubocop:enable Style/SymbolLiteral } end |
Instance Method Details
#==(other) ⇒ Object
Checks equality by comparing each attribute.
195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 |
# File 'lib/oci/limits/models/quota.rb', line 195 def ==(other) return true if equal?(other) self.class == other.class && id == other.id && compartment_id == other.compartment_id && name == other.name && statements == other.statements && locks == other.locks && description == other.description && time_created == other.time_created && lifecycle_state == other.lifecycle_state && == other. && == other. end |
#build_from_hash(attributes) ⇒ Object
Builds the object from hash
234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 |
# File 'lib/oci/limits/models/quota.rb', line 234 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
214 215 216 |
# File 'lib/oci/limits/models/quota.rb', line 214 def eql?(other) self == other end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
223 224 225 |
# File 'lib/oci/limits/models/quota.rb', line 223 def hash [id, compartment_id, name, statements, locks, description, time_created, lifecycle_state, , ].hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
267 268 269 270 271 272 273 274 275 276 |
# File 'lib/oci/limits/models/quota.rb', line 267 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
261 262 263 |
# File 'lib/oci/limits/models/quota.rb', line 261 def to_s to_hash.to_s end |