Oracle Cloud Infrastructure Documentation
Try Free Tier

Limits Common Types

DBMS_CLOUD_OCI_LIMITS_VARCHAR2_TBL Type

Nested table type of varchar2(32767).

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_limits_varchar2_tbl FORCE IS TABLE OF (varchar2(32767)) NOT PERSISTABLE;

DBMS_CLOUD_OCI_LIMITS_ADD_LOCK_DETAILS_T Type

Request payload to add lock to the resource. The FULL lock type allows no modifications (delete, create, update). The DELETE lock type allows all modifications, but delete is not allowed.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_limits_add_lock_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  l_type varchar2(32767),
  related_resource_id varchar2(32767),
  message varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_limits_add_lock_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_limits_add_lock_details_t (
    l_type varchar2,
    related_resource_id varchar2,
    message varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

l_type

(required) Lock type.

Allowed values are: 'FULL', 'DELETE'

related_resource_id

(optional) The resource ID that is locking this resource. Indicates that deleting this resource removes the lock.

message

(optional) A message added by the lock creator. The message typically gives an indication of why the resource is locked.

DBMS_CLOUD_OCI_LIMITS_ADD_LOCK_DETAILS_TBL Type

Nested table type of dbms_cloud_oci_limits_add_lock_details_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_limits_add_lock_details_tbl FORCE IS TABLE OF (dbms_cloud_oci_limits_add_lock_details_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_LIMITS_CREATE_QUOTA_DETAILS_T Type

Request object for create quota operation.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_limits_create_quota_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  compartment_id varchar2(32767),
  description varchar2(32767),
  name varchar2(32767),
  statements dbms_cloud_oci_limits_varchar2_tbl,
  locks dbms_cloud_oci_limits_add_lock_details_tbl,
  freeform_tags json_element_t,
  defined_tags json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_limits_create_quota_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_limits_create_quota_details_t (
    compartment_id varchar2,
    description varchar2,
    name varchar2,
    statements dbms_cloud_oci_limits_varchar2_tbl,
    locks dbms_cloud_oci_limits_add_lock_details_tbl,
    freeform_tags json_element_t,
    defined_tags json_element_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

compartment_id

(required) The OCID of the compartment containing the resource this quota applies to.

description

(required) The description you assign to the quota.

name

(required) The name you assign to the quota during creation. The name must be unique across all quotas in the tenancy and cannot be changed.

statements

(required) An array of quota statements written in the declarative quota statement language.

locks

(optional) Locks associated with this resource.

freeform_tags

(optional) 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\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: `{\"Operations\": {\"CostCenter\": \"42\"}}`

DBMS_CLOUD_OCI_LIMITS_ERROR_T Type

Generic error object.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_limits_error_t FORCE AUTHID CURRENT_USER IS OBJECT (
  code varchar2(32767),
  message varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_limits_error_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_limits_error_t (
    code varchar2,
    message varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

code

(required) A short error code that defines the error, meant for programmatic parsing. See API Errors.

message

(required) A human-readable error string.

DBMS_CLOUD_OCI_LIMITS_LIMIT_DEFINITION_SUMMARY_T Type

The metadata specific to a resource limit definition.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_limits_limit_definition_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
  name varchar2(32767),
  service_name varchar2(32767),
  description varchar2(32767),
  scope_type varchar2(32767),
  are_quotas_supported number,
  is_resource_availability_supported number,
  is_deprecated number,
  is_eligible_for_limit_increase number,
  is_dynamic number,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_limits_limit_definition_summary_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_limits_limit_definition_summary_t (
    name varchar2,
    service_name varchar2,
    description varchar2,
    scope_type varchar2,
    are_quotas_supported number,
    is_resource_availability_supported number,
    is_deprecated number,
    is_eligible_for_limit_increase number,
    is_dynamic number
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

name

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

service_name

(optional) The service name of the limit.

description

(optional) The limit description.

scope_type

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

Allowed values are: 'GLOBAL', 'REGION', 'AD'

are_quotas_supported

(optional) If true, quota policies can be created on top of this resource limit.

is_resource_availability_supported

(optional) Reflects whether or not the GetResourceAvailability API is supported for this limit. If not, the API returns an empty JSON response.

is_deprecated

(optional) Indicates if the limit has been deprecated.

is_eligible_for_limit_increase

(optional) Indicates if the customer can request a limit increase for this resource.

is_dynamic

(optional) The limit for this resource has a dynamic value that is based on consumption across all OCI services.

DBMS_CLOUD_OCI_LIMITS_LIMIT_VALUE_SUMMARY_T Type

The value of a specific resource limit.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_limits_limit_value_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
  name varchar2(32767),
  scope_type varchar2(32767),
  availability_domain varchar2(32767),
  value number,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_limits_limit_value_summary_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_limits_limit_value_summary_t (
    name varchar2,
    scope_type varchar2,
    availability_domain varchar2,
    value number
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

name

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

scope_type

(optional) The scope type of the limit.

Allowed values are: 'GLOBAL', 'REGION', 'AD'

availability_domain

(optional) If present, the returned value is only specific to this availability domain.

value

(optional) The resource limit value.

DBMS_CLOUD_OCI_LIMITS_RESOURCE_LOCK_T Type

Resource locks prevent certain APIs from being called for the resource. A full lock prevents both updating and deleting the resource. A lock delete prevents deleting the resource.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_limits_resource_lock_t FORCE AUTHID CURRENT_USER IS OBJECT (
  l_type varchar2(32767),
  related_resource_id varchar2(32767),
  message varchar2(32767),
  time_created timestamp with time zone,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_limits_resource_lock_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_limits_resource_lock_t (
    l_type varchar2,
    related_resource_id varchar2,
    message varchar2,
    time_created timestamp with time zone
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

l_type

(required) Lock type.

Allowed values are: 'FULL', 'DELETE'

related_resource_id

(optional) The resource ID that is locking this resource. Indicates that deleting this resource removes the lock.

message

(optional) A message added by the lock creator. The message typically gives an indication of why the resource is locked.

time_created

(optional) Indicates when the lock was created, in the format defined by RFC 3339.

DBMS_CLOUD_OCI_LIMITS_RESOURCE_LOCK_TBL Type

Nested table type of dbms_cloud_oci_limits_resource_lock_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_limits_resource_lock_tbl FORCE IS TABLE OF (dbms_cloud_oci_limits_resource_lock_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_LIMITS_QUOTA_T Type

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.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_limits_quota_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  compartment_id varchar2(32767),
  name varchar2(32767),
  statements dbms_cloud_oci_limits_varchar2_tbl,
  locks dbms_cloud_oci_limits_resource_lock_tbl,
  description varchar2(32767),
  time_created timestamp with time zone,
  lifecycle_state varchar2(32767),
  freeform_tags json_element_t,
  defined_tags json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_limits_quota_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_limits_quota_t (
    id varchar2,
    compartment_id varchar2,
    name varchar2,
    statements dbms_cloud_oci_limits_varchar2_tbl,
    locks dbms_cloud_oci_limits_resource_lock_tbl,
    description varchar2,
    time_created timestamp with time zone,
    lifecycle_state varchar2,
    freeform_tags json_element_t,
    defined_tags json_element_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

id

(required) The OCID of the quota.

compartment_id

(required) The OCID of the compartment containing the resource this quota applies to.

name

(required) The name you assign to the quota during creation. The name must be unique across all quotas in the tenancy and cannot be changed.

statements

(required) An array of one or more quota statements written in the declarative quota statement language.

locks

(optional) Locks associated with this resource.

description

(required) The description you assign to the quota.

time_created

(required) Date and time the quota was created, in the format defined by RFC 3339. Example: `2016-08-25T21:10:29.600Z`

lifecycle_state

(optional) The quota's current state. After creating a quota, make sure its `lifecycleState` is set to ACTIVE before using it.

Allowed values are: 'ACTIVE'

freeform_tags

(optional) 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\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: `{\"Operations\": {\"CostCenter\": \"42\"}}`

DBMS_CLOUD_OCI_LIMITS_QUOTA_SUMMARY_T Type

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.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_limits_quota_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  compartment_id varchar2(32767),
  name varchar2(32767),
  description varchar2(32767),
  time_created timestamp with time zone,
  locks dbms_cloud_oci_limits_resource_lock_tbl,
  lifecycle_state varchar2(32767),
  freeform_tags json_element_t,
  defined_tags json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_limits_quota_summary_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_limits_quota_summary_t (
    id varchar2,
    compartment_id varchar2,
    name varchar2,
    description varchar2,
    time_created timestamp with time zone,
    locks dbms_cloud_oci_limits_resource_lock_tbl,
    lifecycle_state varchar2,
    freeform_tags json_element_t,
    defined_tags json_element_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

id

(required) The OCID of the quota.

compartment_id

(required) The OCID of the compartment containing the resource this quota applies to.

name

(required) The name you assign to the quota during creation. The name must be unique across all quotas in the tenancy and cannot be changed.

description

(required) The description you assign to the quota.

time_created

(required) Date and time the quota was created, in the format defined by RFC 3339. Example: `2016-08-25T21:10:29.600Z`

locks

(optional) Locks associated with this resource.

lifecycle_state

(optional) The quota's current state. After creating a quota, make sure its `lifecycleState` is set to ACTIVE before using it.

Allowed values are: 'ACTIVE'

freeform_tags

(optional) 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\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: `{\"Operations\": {\"CostCenter\": \"42\"}}`

DBMS_CLOUD_OCI_LIMITS_REMOVE_LOCK_DETAILS_T Type

Request payload to remove the resource lock.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_limits_remove_lock_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  l_type varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_limits_remove_lock_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_limits_remove_lock_details_t (
    l_type varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

l_type

(required) Lock type.

Allowed values are: 'FULL', 'DELETE'

DBMS_CLOUD_OCI_LIMITS_RESOURCE_AVAILABILITY_T Type

The availability of a given resource limit, based on the usage, tenant service limits, and quotas set for the tenancy. Note: We cannot guarantee this data for all the limits. In such cases, these fields will be empty.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_limits_resource_availability_t FORCE AUTHID CURRENT_USER IS OBJECT (
  used number,
  available number,
  fractional_usage number,
  fractional_availability number,
  effective_quota_value number,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_limits_resource_availability_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_limits_resource_availability_t (
    used number,
    available number,
    fractional_usage number,
    fractional_availability number,
    effective_quota_value number
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

used

(optional) The current usage in the given compartment. To support resources with fractional counts, the field rounds up to the nearest integer.

available

(optional) The count of available resources. To support resources with fractional counts, the field rounds down to the nearest integer.

fractional_usage

(optional) The current most accurate usage in the given compartment.

fractional_availability

(optional) The most accurate count of available resources.

effective_quota_value

(optional) The effective quota value for the given compartment. This field is only present if there is a current quota policy affecting the current resource in the target region or availability domain.

DBMS_CLOUD_OCI_LIMITS_SERVICE_SUMMARY_T Type

A specific OCI service supported by resource limits.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_limits_service_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
  name varchar2(32767),
  description varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_limits_service_summary_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_limits_service_summary_t (
    name varchar2,
    description varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

name

(optional) The service name. Use this when calling other APIs.

description

(optional) The friendly service name.

DBMS_CLOUD_OCI_LIMITS_UPDATE_QUOTA_DETAILS_T Type

Request object for update quota operation.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_limits_update_quota_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  description varchar2(32767),
  statements dbms_cloud_oci_limits_varchar2_tbl,
  freeform_tags json_element_t,
  defined_tags json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_limits_update_quota_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_limits_update_quota_details_t (
    description varchar2,
    statements dbms_cloud_oci_limits_varchar2_tbl,
    freeform_tags json_element_t,
    defined_tags json_element_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

description

(optional) The description you assign to the quota.

statements

(optional) An array of quota statements written in the declarative quota statement language.

freeform_tags

(optional) 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\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: `{\"Operations\": {\"CostCenter\": \"42\"}}`

Was this article helpful?