LimitDefinitionSummary

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

Bases: object

The metadata specific to a resource limit definition.

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.
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_resource_availability_supported

Gets the is_resource_availability_supported of this LimitDefinitionSummary. Reflects if the GetResourceAvailability API is supported for this limit or not. If not, the API will return 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: which can be Global (across all regions), regional or ad 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