LimitDefinitionSummary¶

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

Bases: object

The metadata specific to a resource limit definition.

Attributes

`SCOPE_TYPE_AD`	A constant which can be used with the scope_type property of a LimitDefinitionSummary.
`SCOPE_TYPE_GLOBAL`	A constant which can be used with the scope_type property of a LimitDefinitionSummary.
`SCOPE_TYPE_REGION`	A constant which can be used with the scope_type property of a LimitDefinitionSummary.
`are_quotas_supported`	Gets the are_quotas_supported of this LimitDefinitionSummary.
`description`	Gets the description of this LimitDefinitionSummary.
`is_deprecated`	Gets the is_deprecated of this LimitDefinitionSummary.
`is_dynamic`	Gets the is_dynamic of this LimitDefinitionSummary.
`is_eligible_for_limit_increase`	Gets the is_eligible_for_limit_increase of this LimitDefinitionSummary.
`is_resource_availability_supported`	Gets the is_resource_availability_supported of this LimitDefinitionSummary.
`name`	Gets the name of this LimitDefinitionSummary.
`scope_type`	Gets the scope_type of this LimitDefinitionSummary.
`service_name`	Gets the service_name of this LimitDefinitionSummary.
`supported_quota_families`	Gets the supported_quota_families of this LimitDefinitionSummary.
`supported_subscriptions`	Gets the supported_subscriptions of this LimitDefinitionSummary.

Methods

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

SCOPE_TYPE_AD = 'AD'¶: A constant which can be used with the scope_type property of a LimitDefinitionSummary. This constant has a value of “AD”

SCOPE_TYPE_GLOBAL = 'GLOBAL'¶: A constant which can be used with the scope_type property of a LimitDefinitionSummary. This constant has a value of “GLOBAL”

SCOPE_TYPE_REGION = 'REGION'¶: A constant which can be used with the scope_type property of a LimitDefinitionSummary. This constant has a value of “REGION”

__init__(**kwargs)¶

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

Parameters:

name (str) – The value to assign to the name property of this LimitDefinitionSummary.
service_name (str) – The value to assign to the service_name property of this LimitDefinitionSummary.
description (str) – The value to assign to the description property of this LimitDefinitionSummary.
scope_type (str) – The value to assign to the scope_type property of this LimitDefinitionSummary. Allowed values for this property are: “GLOBAL”, “REGION”, “AD”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
are_quotas_supported (bool) – The value to assign to the are_quotas_supported property of this LimitDefinitionSummary.
is_resource_availability_supported (bool) – The value to assign to the is_resource_availability_supported property of this LimitDefinitionSummary.
is_deprecated (bool) – The value to assign to the is_deprecated property of this LimitDefinitionSummary.
is_eligible_for_limit_increase (bool) – The value to assign to the is_eligible_for_limit_increase property of this LimitDefinitionSummary.
is_dynamic (bool) – The value to assign to the is_dynamic property of this LimitDefinitionSummary.
supported_subscriptions (list[str]) – The value to assign to the supported_subscriptions property of this LimitDefinitionSummary.
supported_quota_families (list[str]) – The value to assign to the supported_quota_families property of this LimitDefinitionSummary.

are_quotas_supported¶

Gets the are_quotas_supported of this LimitDefinitionSummary. If true, quota policies can be created on top of this resource limit.

Returns:	The are_quotas_supported of this LimitDefinitionSummary.
Return type:	bool

description¶

Gets the description of this LimitDefinitionSummary. The limit description.

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

is_deprecated¶

Gets the is_deprecated of this LimitDefinitionSummary. Indicates if the limit has been deprecated.

Returns:	The is_deprecated of this LimitDefinitionSummary.
Return type:	bool

is_dynamic¶

Gets the is_dynamic of this LimitDefinitionSummary. The limit for this resource has a dynamic value that is based on consumption across all OCI services.

Returns:	The is_dynamic of this LimitDefinitionSummary.
Return type:	bool

is_eligible_for_limit_increase¶

Gets the is_eligible_for_limit_increase of this LimitDefinitionSummary. Indicates if the customer can request a limit increase for this resource.

Returns:	The is_eligible_for_limit_increase of this LimitDefinitionSummary.
Return type:	bool

is_resource_availability_supported¶

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

Returns:	The is_resource_availability_supported of this LimitDefinitionSummary.
Return type:	bool

name¶

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

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

scope_type¶

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

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

Returns:	The scope_type of this LimitDefinitionSummary.
Return type:	str

service_name¶

Gets the service_name of this LimitDefinitionSummary. The service name of the limit.

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

supported_quota_families¶

Gets the supported_quota_families of this LimitDefinitionSummary. Supported quota family names for creation of quota policy.

Returns:	The supported_quota_families of this LimitDefinitionSummary.
Return type:	list[str]

supported_subscriptions¶

Gets the supported_subscriptions of this LimitDefinitionSummary. An array of subscription types supported by the limit. e,g The type of subscription, such as ‘SAAS’, ‘ERP’, ‘CRM’.

Returns:	The supported_subscriptions of this LimitDefinitionSummary.
Return type:	list[str]