Quota¶

class oci.limits.models.Quota(**kwargs)¶

Bases: object

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.

Attributes

`LIFECYCLE_STATE_ACTIVE`	A constant which can be used with the lifecycle_state property of a Quota.
`compartment_id`	[Required] Gets the compartment_id of this Quota.
`defined_tags`	Gets the defined_tags of this Quota.
`description`	[Required] Gets the description of this Quota.
`freeform_tags`	Gets the freeform_tags of this Quota.
`id`	[Required] Gets the id of this Quota.
`lifecycle_state`	Gets the lifecycle_state of this Quota.
`locks`	Gets the locks of this Quota.
`name`	[Required] Gets the name of this Quota.
`statements`	[Required] Gets the statements of this Quota.
`time_created`	[Required] Gets the time_created of this Quota.

Methods

__init__(**kwargs) Initializes a new Quota object with values from keyword arguments.

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶: A constant which can be used with the lifecycle_state property of a Quota. This constant has a value of “ACTIVE”

__init__(**kwargs)¶

Initializes a new Quota object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:

id (str) – The value to assign to the id property of this Quota.
compartment_id (str) – The value to assign to the compartment_id property of this Quota.
name (str) – The value to assign to the name property of this Quota.
statements (list[str]) – The value to assign to the statements property of this Quota.
locks (list[oci.limits.models.ResourceLock]) – The value to assign to the locks property of this Quota.
description (str) – The value to assign to the description property of this Quota.
time_created (datetime) – The value to assign to the time_created property of this Quota.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this Quota. Allowed values for this property are: “ACTIVE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this Quota.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this Quota.

compartment_id¶

[Required] Gets the compartment_id of this Quota. The OCID of the compartment containing the resource this quota applies to.

Returns:	The compartment_id of this Quota.
Return type:	str

defined_tags¶

Gets the defined_tags of this Quota. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {“Operations”: {“CostCenter”: “42”}}

Returns:	The defined_tags of this Quota.
Return type:	dict(str, dict(str, object))

description¶

[Required] Gets the description of this Quota. The description you assign to the quota.

Returns:	The description of this Quota.
Return type:	str

freeform_tags¶

Gets the freeform_tags of this Quota. 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”}

Returns:	The freeform_tags of this Quota.
Return type:	dict(str, str)

id¶

[Required] Gets the id of this Quota. The OCID of the quota.

Returns:	The id of this Quota.
Return type:	str

lifecycle_state¶

Gets the lifecycle_state of this Quota. The quota’s current state. After creating a quota, make sure its lifecycleState is set to ACTIVE before using it.

Allowed values for this property are: “ACTIVE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The lifecycle_state of this Quota.
Return type:	str

locks¶

Gets the locks of this Quota. Locks associated with this resource.

Returns:	The locks of this Quota.
Return type:	list[oci.limits.models.ResourceLock]

name¶

[Required] Gets the name of this Quota. The name you assign to the quota during creation. The name must be unique across all quotas in the tenancy and cannot be changed.

Returns:	The name of this Quota.
Return type:	str

statements¶

[Required] Gets the statements of this Quota. An array of one or more quota statements written in the declarative quota statement language.

Returns:	The statements of this Quota.
Return type:	list[str]

time_created¶

[Required] Gets the time_created of this Quota. Date and time the quota was created, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z

Returns:	The time_created of this Quota.
Return type:	datetime