Oracle Cloud Infrastructure Documentation
Try Free Tier

Usage Common Types

DBMS_CLOUD_OCI_USAGE_VARCHAR2_TBL Type

Nested table type of varchar2(32767).

Syntax

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

DBMS_CLOUD_OCI_USAGE_REDEEMABLE_USER_T Type

The summary of a user that can redeem rewards.

Syntax

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

Fields

Field Description

email_id

(required) The email ID for a user that can redeem rewards.

first_name

(optional) The first name of the user that can redeem rewards.

last_name

(optional) The last name of the user that can redeem rewards.

DBMS_CLOUD_OCI_USAGE_REDEEMABLE_USER_TBL Type

Nested table type of dbms_cloud_oci_usage_redeemable_user_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_usage_redeemable_user_tbl FORCE IS TABLE OF (dbms_cloud_oci_usage_redeemable_user_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_USAGE_CREATE_REDEEMABLE_USER_DETAILS_T Type

A list of new user to be added to the list of user that can redeem rewards.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_usage_create_redeemable_user_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  items dbms_cloud_oci_usage_redeemable_user_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_usage_create_redeemable_user_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_usage_create_redeemable_user_details_t (
    items dbms_cloud_oci_usage_redeemable_user_tbl
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

items

(optional) The list of new user to be added to the list of user that can redeem rewards.

DBMS_CLOUD_OCI_USAGE_ERROR_T Type

Error object model.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_usage_error_t FORCE AUTHID CURRENT_USER IS OBJECT (
  code varchar2(32767),
  message varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_usage_error_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_usage_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.

message

(required) A human-readable error string.

DBMS_CLOUD_OCI_USAGE_MONTHLY_REWARD_SUMMARY_T Type

Object describing the monthly rewards summary for the requested subscription ID.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_usage_monthly_reward_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
  available_rewards number,
  redeemed_rewards number,
  earned_rewards number,
  is_manual number,
  time_rewards_expired timestamp with time zone,
  time_rewards_earned timestamp with time zone,
  time_usage_started timestamp with time zone,
  time_usage_ended timestamp with time zone,
  usage_amount number,
  eligible_usage_amount number,
  ineligible_usage_amount number,
  usage_period_key varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_usage_monthly_reward_summary_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_usage_monthly_reward_summary_t (
    available_rewards number,
    redeemed_rewards number,
    earned_rewards number,
    is_manual number,
    time_rewards_expired timestamp with time zone,
    time_rewards_earned timestamp with time zone,
    time_usage_started timestamp with time zone,
    time_usage_ended timestamp with time zone,
    usage_amount number,
    eligible_usage_amount number,
    ineligible_usage_amount number,
    usage_period_key varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

available_rewards

(optional) The number of rewards available for a specific usage period.

redeemed_rewards

(optional) The number of rewards redeemed for a specific month.

earned_rewards

(optional) The number of rewards earned for the specific usage period.

is_manual

(optional) The boolean parameter to indicate whether or not the available rewards are manually posted.

time_rewards_expired

(optional) The date and time when rewards expire.

time_rewards_earned

(optional) The date and time when rewards accrue.

time_usage_started

(optional) The start date and time for the usage period.

time_usage_ended

(optional) The end date and time for the usage period.

usage_amount

(optional) The usage amount for the usage period.

eligible_usage_amount

(optional) The eligible usage amount for the usage period.

ineligible_usage_amount

(optional) The ineligible usage amount for the usage period.

usage_period_key

(optional) The usage period ID.

DBMS_CLOUD_OCI_USAGE_PRODUCT_SUMMARY_T Type

Provides details about product rewards and the usage amount.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_usage_product_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
  product_number varchar2(32767),
  product_name varchar2(32767),
  usage_amount number,
  earned_rewards number,
  is_eligible_to_earn_rewards number,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_usage_product_summary_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_usage_product_summary_t (
    product_number varchar2,
    product_name varchar2,
    usage_amount number,
    earned_rewards number,
    is_eligible_to_earn_rewards number
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

product_number

(optional) The rate card product number.

product_name

(optional) The rate card product name.

usage_amount

(optional) The rate card product usage amount.

earned_rewards

(optional) The earned rewards for the product.

is_eligible_to_earn_rewards

(optional) The boolean parameter to indicate if the product is eligible to earn rewards.

DBMS_CLOUD_OCI_USAGE_PRODUCT_SUMMARY_TBL Type

Nested table type of dbms_cloud_oci_usage_product_summary_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_usage_product_summary_tbl FORCE IS TABLE OF (dbms_cloud_oci_usage_product_summary_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_USAGE_PRODUCT_COLLECTION_T Type

A product list.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_usage_product_collection_t FORCE AUTHID CURRENT_USER IS OBJECT (
  items dbms_cloud_oci_usage_product_summary_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_usage_product_collection_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_usage_product_collection_t (
    items dbms_cloud_oci_usage_product_summary_tbl
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

items

(required) The list of product rewards summaries.

DBMS_CLOUD_OCI_USAGE_REDEEMABLE_USER_SUMMARY_T Type

User summary that can redeem rewards.

Syntax

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

Fields

Field Description

email_id

(optional) The email ID of the user that can redeem rewards.

first_name

(optional) The first name of the user that can redeem rewards.

last_name

(optional) The last name of the user that can redeem rewards.

DBMS_CLOUD_OCI_USAGE_REDEEMABLE_USER_SUMMARY_TBL Type

Nested table type of dbms_cloud_oci_usage_redeemable_user_summary_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_usage_redeemable_user_summary_tbl FORCE IS TABLE OF (dbms_cloud_oci_usage_redeemable_user_summary_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_USAGE_REDEEMABLE_USER_COLLECTION_T Type

The list of user summary that can redeem rewards.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_usage_redeemable_user_collection_t FORCE AUTHID CURRENT_USER IS OBJECT (
  items dbms_cloud_oci_usage_redeemable_user_summary_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_usage_redeemable_user_collection_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_usage_redeemable_user_collection_t (
    items dbms_cloud_oci_usage_redeemable_user_summary_tbl
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

items

(required) The list of user summary that can redeem rewards.

DBMS_CLOUD_OCI_USAGE_REDEMPTION_SUMMARY_T Type

The redemption summary for the requested subscription ID and date range.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_usage_redemption_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
  time_redeemed timestamp with time zone,
  redemption_email varchar2(32767),
  redemption_code varchar2(32767),
  invoice_number varchar2(32767),
  invoice_total_amount number,
  invoice_currency varchar2(32767),
  redeemed_rewards number,
  base_rewards number,
  fx_rate number,
  time_invoiced timestamp with time zone,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_usage_redemption_summary_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_usage_redemption_summary_t (
    time_redeemed timestamp with time zone,
    redemption_email varchar2,
    redemption_code varchar2,
    invoice_number varchar2,
    invoice_total_amount number,
    invoice_currency varchar2,
    redeemed_rewards number,
    base_rewards number,
    fx_rate number,
    time_invoiced timestamp with time zone
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

time_redeemed

(optional) It provides redeem date.

redemption_email

(optional) It provides the redemption email id.

redemption_code

(optional) The redemption code used in the Billing Center during the reward redemption process.

invoice_number

(optional) It provides the invoice number against the redemption.

invoice_total_amount

(optional) It provides the invoice total amount of given redemption.

invoice_currency

(optional) The currency associated with invoice.

redeemed_rewards

(optional) It provides the redeemed rewards in invoice currency.

base_rewards

(optional) It provides the redeemed rewards in base/subscription currency.

fx_rate

(optional) It provides the fxRate between invoice currency and subscription currency.

time_invoiced

(optional) It provides the invoice date.

DBMS_CLOUD_OCI_USAGE_REDEMPTION_SUMMARY_TBL Type

Nested table type of dbms_cloud_oci_usage_redemption_summary_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_usage_redemption_summary_tbl FORCE IS TABLE OF (dbms_cloud_oci_usage_redemption_summary_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_USAGE_REDEMPTION_COLLECTION_T Type

The list of redemption summary for the requested subscription ID and date range.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_usage_redemption_collection_t FORCE AUTHID CURRENT_USER IS OBJECT (
  items dbms_cloud_oci_usage_redemption_summary_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_usage_redemption_collection_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_usage_redemption_collection_t (
    items dbms_cloud_oci_usage_redemption_summary_tbl
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

items

(required) The list of redemption summary.

DBMS_CLOUD_OCI_USAGE_RESOURCE_QUOTUM_SUMMARY_T Type

The resource quota balance details.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_usage_resource_quotum_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
  name varchar2(32767),
  is_allowed number,
  limit number,
  balance number,
  is_overage number,
  purchased_limit number,
  service varchar2(32767),
  is_dependency number,
  affected_resource varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_usage_resource_quotum_summary_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_usage_resource_quotum_summary_t (
    name varchar2,
    is_allowed number,
    limit number,
    balance number,
    is_overage number,
    purchased_limit number,
    service varchar2,
    is_dependency number,
    affected_resource varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

name

(optional) The resource name.

is_allowed

(optional) Used to indicate if further quota consumption isAllowed.

limit

(optional) The quota limit.

balance

(optional) The quota balance.

is_overage

(optional) Used to indicate if overages are incurred.

purchased_limit

(optional) The purchased quota limit.

service

(optional) The service name.

is_dependency

(optional) Used to indicate any resource dependencies.

affected_resource

(optional) The affected resource name.

DBMS_CLOUD_OCI_USAGE_RESOURCE_QUOTUM_SUMMARY_TBL Type

Nested table type of dbms_cloud_oci_usage_resource_quotum_summary_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_usage_resource_quotum_summary_tbl FORCE IS TABLE OF (dbms_cloud_oci_usage_resource_quotum_summary_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_USAGE_RESOURCE_QUOTUM_COLLECTION_T Type

The quota details of resources under a tenancy.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_usage_resource_quotum_collection_t FORCE AUTHID CURRENT_USER IS OBJECT (
  items dbms_cloud_oci_usage_resource_quotum_summary_tbl,
  is_allowed number,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_usage_resource_quotum_collection_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_usage_resource_quotum_collection_t (
    items dbms_cloud_oci_usage_resource_quotum_summary_tbl,
    is_allowed number
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

items

(required) The list of resource quota details.

is_allowed

(required) Used to indicate if further quota consumption isAllowed.

DBMS_CLOUD_OCI_USAGE_SKU_PRODUCTS_T Type

The SKU Product Id details for a resource.

Syntax

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

Fields

Field Description

sku_id

(optional) The Sku Id for the resource.

sku_type

(optional) The Sku type for the resource.

cloud_credit_type

(optional) The cloud credit type for the resource.

DBMS_CLOUD_OCI_USAGE_SKU_PRODUCTS_TBL Type

Nested table type of dbms_cloud_oci_usage_sku_products_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_usage_sku_products_tbl FORCE IS TABLE OF (dbms_cloud_oci_usage_sku_products_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_USAGE_RESOURCE_SUMMARY_T Type

The details of a resource under a service.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_usage_resource_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
  daily_unit_display_name varchar2(32767),
  hourly_unit_display_name varchar2(32767),
  raw_unit_display_name varchar2(32767),
  usage_data_type varchar2(32767),
  name varchar2(32767),
  servicename varchar2(32767),
  description varchar2(32767),
  instance_type varchar2(32767),
  is_purchased number,
  child_resources dbms_cloud_oci_usage_varchar2_tbl,
  skus dbms_cloud_oci_usage_sku_products_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_usage_resource_summary_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_usage_resource_summary_t (
    daily_unit_display_name varchar2,
    hourly_unit_display_name varchar2,
    raw_unit_display_name varchar2,
    usage_data_type varchar2,
    name varchar2,
    servicename varchar2,
    description varchar2,
    instance_type varchar2,
    is_purchased number,
    child_resources dbms_cloud_oci_usage_varchar2_tbl,
    skus dbms_cloud_oci_usage_sku_products_tbl
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

daily_unit_display_name

(optional) Units to be used for daily aggregated data.

hourly_unit_display_name

(optional) Units to be used for hourly aggregated data.

raw_unit_display_name

(optional) Default units to use when unspecified.

usage_data_type

(optional) Usage data type of the resource.

Allowed values are: 'INTERVAL', 'POINT_DATA'

name

(optional) Name of the resource.

servicename

(optional) Name of the service.

description

(optional) Description of the resource.

instance_type

(optional) Instance type for the resource.

is_purchased

(optional) Indicates if the SKU was purchased

child_resources

(optional) The details of any child resources.

skus

(optional) The details of resource Skus.

DBMS_CLOUD_OCI_USAGE_RESOURCE_SUMMARY_TBL Type

Nested table type of dbms_cloud_oci_usage_resource_summary_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_usage_resource_summary_tbl FORCE IS TABLE OF (dbms_cloud_oci_usage_resource_summary_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_USAGE_RESOURCES_COLLECTION_T Type

The resources of a service.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_usage_resources_collection_t FORCE AUTHID CURRENT_USER IS OBJECT (
  items dbms_cloud_oci_usage_resource_summary_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_usage_resources_collection_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_usage_resources_collection_t (
    items dbms_cloud_oci_usage_resource_summary_tbl
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

items

(required) The list of resource details for a service.

DBMS_CLOUD_OCI_USAGE_REWARD_DETAILS_T Type

The overall monthly reward summary.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_usage_reward_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  tenancy_id varchar2(32767),
  subscription_id varchar2(32767),
  currency varchar2(32767),
  rewards_rate number,
  total_rewards_available number,
  redemption_code varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_usage_reward_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_usage_reward_details_t (
    tenancy_id varchar2,
    subscription_id varchar2,
    currency varchar2,
    rewards_rate number,
    total_rewards_available number,
    redemption_code varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

tenancy_id

(optional) The OCID of the target tenancy.

subscription_id

(optional) The entitlement ID from MQS, which is the same as the subcription ID.

currency

(optional) The currency unit for the reward amount.

rewards_rate

(optional) The current Rewards percentage in decimal format.

total_rewards_available

(optional) The total number of available rewards for a given subscription ID.

redemption_code

(optional) The redemption code used in the Billing Center during the reward redemption process.

DBMS_CLOUD_OCI_USAGE_MONTHLY_REWARD_SUMMARY_TBL Type

Nested table type of dbms_cloud_oci_usage_monthly_reward_summary_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_usage_monthly_reward_summary_tbl FORCE IS TABLE OF (dbms_cloud_oci_usage_monthly_reward_summary_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_USAGE_REWARD_COLLECTION_T Type

The response object for the ListRewards API call. Provides information about the subscription rewards.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_usage_reward_collection_t FORCE AUTHID CURRENT_USER IS OBJECT (
  summary dbms_cloud_oci_usage_reward_details_t,
  items dbms_cloud_oci_usage_monthly_reward_summary_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_usage_reward_collection_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_usage_reward_collection_t (
    summary dbms_cloud_oci_usage_reward_details_t,
    items dbms_cloud_oci_usage_monthly_reward_summary_tbl
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

summary

(required)

items

(optional) The monthly summary of rewards.

DBMS_CLOUD_OCI_USAGE_USAGE_LIMIT_SUMMARY_T Type

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

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_usage_usage_limit_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
  time_created timestamp with time zone,
  entitlement_id varchar2(32767),
  id varchar2(32767),
  time_modified timestamp with time zone,
  resource_name varchar2(32767),
  service_name varchar2(32767),
  limit varchar2(32767),
  created_by varchar2(32767),
  modified_by varchar2(32767),
  action varchar2(32767),
  alert_level number,
  limit_type varchar2(32767),
  value_type varchar2(32767),
  lifecycle_state varchar2(32767),
  max_hard_limit varchar2(32767),
  sku_part_id varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_usage_usage_limit_summary_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_usage_usage_limit_summary_t (
    time_created timestamp with time zone,
    entitlement_id varchar2,
    id varchar2,
    time_modified timestamp with time zone,
    resource_name varchar2,
    service_name varchar2,
    limit varchar2,
    created_by varchar2,
    modified_by varchar2,
    action varchar2,
    alert_level number,
    limit_type varchar2,
    value_type varchar2,
    lifecycle_state varchar2,
    max_hard_limit varchar2,
    sku_part_id varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

time_created

(required) Time when the usage limit was created

entitlement_id

(required) Entitlement ID of the usage limit

id

(required) The usage limit ID

time_modified

(required) Time when the usage limit was modified

resource_name

(required) The resource for which the limit is defined

service_name

(required) The service for which the limit is defined

limit

(required) The limit value

created_by

(required) The user who created the limit

modified_by

(required) The user who modified the limit

action

(required) The action when usage limit is hit

Allowed values are: 'QUOTA_BREACH', 'QUOTA_ALERT'

alert_level

(required) The alert level of the usage limit

limit_type

(required) The limit type of the usage limit

Allowed values are: 'HARD', 'SOFT'

value_type

(required) The value type of the usage limit

Allowed values are: 'ABSOLUTE', 'PERCENTAGE'

lifecycle_state

(required) The usage limit lifecycle state.

Allowed values are: 'ACTIVE'

max_hard_limit

(optional) The maximum hard limit set for the usage limit

sku_part_id

(optional) The SKU for which the usage limit is set

DBMS_CLOUD_OCI_USAGE_USAGE_LIMIT_SUMMARY_TBL Type

Nested table type of dbms_cloud_oci_usage_usage_limit_summary_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_usage_usage_limit_summary_tbl FORCE IS TABLE OF (dbms_cloud_oci_usage_usage_limit_summary_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_USAGE_USAGE_LIMIT_COLLECTION_T Type

The list of usage limit summary for the requested tenancy ID and subscription ID.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_usage_usage_limit_collection_t FORCE AUTHID CURRENT_USER IS OBJECT (
  items dbms_cloud_oci_usage_usage_limit_summary_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_usage_usage_limit_collection_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_usage_usage_limit_collection_t (
    items dbms_cloud_oci_usage_usage_limit_summary_tbl
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

items

(required) The list of usage limits.

Was this article helpful?