UsageLimitSummary¶

class oci.usage.models.UsageLimitSummary(**kwargs)¶

Bases: object

Encapsulates a collection of Hard and Soft Limits for a resource within a subscription.

Attributes

`ACTION_QUOTA_ALERT`	A constant which can be used with the action property of a UsageLimitSummary.
`ACTION_QUOTA_BREACH`	A constant which can be used with the action property of a UsageLimitSummary.
`LIFECYCLE_STATE_ACTIVE`	A constant which can be used with the lifecycle_state property of a UsageLimitSummary.
`LIMIT_TYPE_HARD`	A constant which can be used with the limit_type property of a UsageLimitSummary.
`LIMIT_TYPE_SOFT`	A constant which can be used with the limit_type property of a UsageLimitSummary.
`VALUE_TYPE_ABSOLUTE`	A constant which can be used with the value_type property of a UsageLimitSummary.
`VALUE_TYPE_PERCENTAGE`	A constant which can be used with the value_type property of a UsageLimitSummary.
`action`	[Required] Gets the action of this UsageLimitSummary.
`alert_level`	[Required] Gets the alert_level of this UsageLimitSummary.
`created_by`	[Required] Gets the created_by of this UsageLimitSummary.
`entitlement_id`	[Required] Gets the entitlement_id of this UsageLimitSummary.
`id`	[Required] Gets the id of this UsageLimitSummary.
`lifecycle_state`	[Required] Gets the lifecycle_state of this UsageLimitSummary.
`limit`	[Required] Gets the limit of this UsageLimitSummary.
`limit_type`	[Required] Gets the limit_type of this UsageLimitSummary.
`max_hard_limit`	Gets the max_hard_limit of this UsageLimitSummary.
`modified_by`	[Required] Gets the modified_by of this UsageLimitSummary.
`resource_name`	[Required] Gets the resource_name of this UsageLimitSummary.
`service_name`	[Required] Gets the service_name of this UsageLimitSummary.
`sku_part_id`	Gets the sku_part_id of this UsageLimitSummary.
`time_created`	[Required] Gets the time_created of this UsageLimitSummary.
`time_modified`	[Required] Gets the time_modified of this UsageLimitSummary.
`value_type`	[Required] Gets the value_type of this UsageLimitSummary.

Methods

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

ACTION_QUOTA_ALERT = 'QUOTA_ALERT'¶: A constant which can be used with the action property of a UsageLimitSummary. This constant has a value of “QUOTA_ALERT”

ACTION_QUOTA_BREACH = 'QUOTA_BREACH'¶: A constant which can be used with the action property of a UsageLimitSummary. This constant has a value of “QUOTA_BREACH”

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

LIMIT_TYPE_HARD = 'HARD'¶: A constant which can be used with the limit_type property of a UsageLimitSummary. This constant has a value of “HARD”

LIMIT_TYPE_SOFT = 'SOFT'¶: A constant which can be used with the limit_type property of a UsageLimitSummary. This constant has a value of “SOFT”

VALUE_TYPE_ABSOLUTE = 'ABSOLUTE'¶: A constant which can be used with the value_type property of a UsageLimitSummary. This constant has a value of “ABSOLUTE”

VALUE_TYPE_PERCENTAGE = 'PERCENTAGE'¶: A constant which can be used with the value_type property of a UsageLimitSummary. This constant has a value of “PERCENTAGE”

__init__(**kwargs)¶

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

Parameters:

time_created (datetime) – The value to assign to the time_created property of this UsageLimitSummary.
entitlement_id (str) – The value to assign to the entitlement_id property of this UsageLimitSummary.
id (str) – The value to assign to the id property of this UsageLimitSummary.
time_modified (datetime) – The value to assign to the time_modified property of this UsageLimitSummary.
resource_name (str) – The value to assign to the resource_name property of this UsageLimitSummary.
service_name (str) – The value to assign to the service_name property of this UsageLimitSummary.
limit (str) – The value to assign to the limit property of this UsageLimitSummary.
created_by (str) – The value to assign to the created_by property of this UsageLimitSummary.
modified_by (str) – The value to assign to the modified_by property of this UsageLimitSummary.
action (str) – The value to assign to the action property of this UsageLimitSummary. Allowed values for this property are: “QUOTA_BREACH”, “QUOTA_ALERT”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
alert_level (float) – The value to assign to the alert_level property of this UsageLimitSummary.
limit_type (str) – The value to assign to the limit_type property of this UsageLimitSummary. Allowed values for this property are: “HARD”, “SOFT”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
value_type (str) – The value to assign to the value_type property of this UsageLimitSummary. Allowed values for this property are: “ABSOLUTE”, “PERCENTAGE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this UsageLimitSummary. Allowed values for this property are: “ACTIVE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
max_hard_limit (str) – The value to assign to the max_hard_limit property of this UsageLimitSummary.
sku_part_id (str) – The value to assign to the sku_part_id property of this UsageLimitSummary.

action¶

[Required] Gets the action of this UsageLimitSummary. The action when usage limit is hit

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

Returns:	The action of this UsageLimitSummary.
Return type:	str

alert_level¶

[Required] Gets the alert_level of this UsageLimitSummary. The alert level of the usage limit

Returns:	The alert_level of this UsageLimitSummary.
Return type:	float

created_by¶

[Required] Gets the created_by of this UsageLimitSummary. The user who created the limit

Returns:	The created_by of this UsageLimitSummary.
Return type:	str

entitlement_id¶

[Required] Gets the entitlement_id of this UsageLimitSummary. Entitlement ID of the usage limit

Returns:	The entitlement_id of this UsageLimitSummary.
Return type:	str

id¶

[Required] Gets the id of this UsageLimitSummary. The usage limit ID

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

lifecycle_state¶

[Required] Gets the lifecycle_state of this UsageLimitSummary. The usage limit lifecycle state.

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 UsageLimitSummary.
Return type:	str

limit¶

[Required] Gets the limit of this UsageLimitSummary. The limit value

Returns:	The limit of this UsageLimitSummary.
Return type:	str

limit_type¶

[Required] Gets the limit_type of this UsageLimitSummary. The limit type of the usage limit

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

Returns:	The limit_type of this UsageLimitSummary.
Return type:	str

max_hard_limit¶

Gets the max_hard_limit of this UsageLimitSummary. The maximum hard limit set for the usage limit

Returns:	The max_hard_limit of this UsageLimitSummary.
Return type:	str

modified_by¶

[Required] Gets the modified_by of this UsageLimitSummary. The user who modified the limit

Returns:	The modified_by of this UsageLimitSummary.
Return type:	str

resource_name¶

[Required] Gets the resource_name of this UsageLimitSummary. The resource for which the limit is defined

Returns:	The resource_name of this UsageLimitSummary.
Return type:	str

service_name¶

[Required] Gets the service_name of this UsageLimitSummary. The service for which the limit is defined

Returns:	The service_name of this UsageLimitSummary.
Return type:	str

sku_part_id¶

Gets the sku_part_id of this UsageLimitSummary. The SKU for which the usage limit is set

Returns:	The sku_part_id of this UsageLimitSummary.
Return type:	str

time_created¶

[Required] Gets the time_created of this UsageLimitSummary. Time when the usage limit was created

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

time_modified¶

[Required] Gets the time_modified of this UsageLimitSummary. Time when the usage limit was modified

Returns:	The time_modified of this UsageLimitSummary.
Return type:	datetime

value_type¶

[Required] Gets the value_type of this UsageLimitSummary. The value type of the usage limit

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

Returns:	The value_type of this UsageLimitSummary.
Return type:	str