QuotaSummary¶

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

Bases: object

Consists of a subset of all the properties of the corresponding quota, and is recommended to be used in cases requiring security of quota details, and for slightly better API performance.

Attributes

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

Methods

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

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

__init__(**kwargs)¶

Initializes a new QuotaSummary 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 QuotaSummary.
compartment_id (str) – The value to assign to the compartment_id property of this QuotaSummary.
name (str) – The value to assign to the name property of this QuotaSummary.
description (str) – The value to assign to the description property of this QuotaSummary.
time_created (datetime) – The value to assign to the time_created property of this QuotaSummary.
locks (list[oci.limits.models.ResourceLock]) – The value to assign to the locks property of this QuotaSummary.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this QuotaSummary. 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 QuotaSummary.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this QuotaSummary.

compartment_id¶

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

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

defined_tags¶

Gets the defined_tags of this QuotaSummary. 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 QuotaSummary.
Return type:	dict(str, dict(str, object))

description¶

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

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

freeform_tags¶

Gets the freeform_tags of this QuotaSummary. 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 QuotaSummary.
Return type:	dict(str, str)

id¶

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

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

lifecycle_state¶

Gets the lifecycle_state of this QuotaSummary. 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 QuotaSummary.
Return type:	str

locks¶

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

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

name¶

[Required] Gets the name of this QuotaSummary. 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 QuotaSummary.
Return type:	str

time_created¶

[Required] Gets the time_created of this QuotaSummary. 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 QuotaSummary.
Return type:	datetime