ONS Common Types
DBMS_CLOUD_OCI_ONS_VARCHAR2_TBL Type
Nested table type of varchar2(32767).
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ons_varchar2_tbl FORCE IS TABLE OF (varchar2(32767)) NOT PERSISTABLE;
DBMS_CLOUD_OCI_ONS_BACKOFF_RETRY_POLICY_T Type
The backoff retry portion of the subscription delivery policy. For information about retry durations for subscriptions, see How Notifications Works.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ons_backoff_retry_policy_t FORCE AUTHID CURRENT_USER IS OBJECT (
max_retry_duration number,
policy_type varchar2(32767),
CONSTRUCTOR FUNCTION dbms_cloud_oci_ons_backoff_retry_policy_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_ons_backoff_retry_policy_t (
max_retry_duration number,
policy_type varchar2
) RETURN SELF AS RESULT
) NOT PERSISTABLE;
Fields
Field | Description |
---|---|
|
(required) The maximum retry duration in milliseconds. Default value is `7200000` (2 hours). |
|
(required) The type of delivery policy. Allowed values are: 'EXPONENTIAL' |
DBMS_CLOUD_OCI_ONS_CHANGE_COMPARTMENT_DETAILS_T Type
The configuration details for the move operation.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ons_change_compartment_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
compartment_id varchar2(32767),
CONSTRUCTOR FUNCTION dbms_cloud_oci_ons_change_compartment_details_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_ons_change_compartment_details_t (
compartment_id varchar2
) RETURN SELF AS RESULT
) NOT PERSISTABLE;
Fields
Field | Description |
---|---|
|
(required) The OCID of the compartment to move the specified topic or subscription to. |
DBMS_CLOUD_OCI_ONS_CONFIRMATION_RESULT_T Type
The confirmation details for the specified subscription.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ons_confirmation_result_t FORCE AUTHID CURRENT_USER IS OBJECT (
topic_name varchar2(32767),
topic_id varchar2(32767),
endpoint varchar2(32767),
unsubscribe_url varchar2(32767),
message varchar2(32767),
subscription_id varchar2(32767),
CONSTRUCTOR FUNCTION dbms_cloud_oci_ons_confirmation_result_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_ons_confirmation_result_t (
topic_name varchar2,
topic_id varchar2,
endpoint varchar2,
unsubscribe_url varchar2,
message varchar2,
subscription_id varchar2
) RETURN SELF AS RESULT
) NOT PERSISTABLE;
Fields
Field | Description |
---|---|
|
(required) The name of the subscribed topic. |
|
(required) The OCID of the topic associated with the specified subscription. |
|
(required) A locator that corresponds to the subscription protocol. For example, an email address for a subscription that uses the `EMAIL` protocol, or a URL for a subscription that uses an HTTP-based protocol. |
|
(required) The URL for unsubscribing from the topic. |
|
(required) A human-readable string indicating the status of the subscription confirmation. |
|
(required) The OCID of the subscription specified in the request. |
DBMS_CLOUD_OCI_ONS_CREATE_SUBSCRIPTION_DETAILS_T Type
The configuration details for creating the subscription.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ons_create_subscription_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
topic_id varchar2(32767),
compartment_id varchar2(32767),
protocol varchar2(32767),
endpoint varchar2(32767),
metadata varchar2(32767),
freeform_tags json_element_t,
defined_tags json_element_t,
CONSTRUCTOR FUNCTION dbms_cloud_oci_ons_create_subscription_details_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_ons_create_subscription_details_t (
topic_id varchar2,
compartment_id varchar2,
protocol varchar2,
endpoint varchar2,
metadata varchar2,
freeform_tags json_element_t,
defined_tags json_element_t
) RETURN SELF AS RESULT
) NOT PERSISTABLE;
Fields
Field | Description |
---|---|
|
(required) The OCID of the topic for the subscription. |
|
(required) The OCID of the compartment for the subscription. |
|
(required) The protocol used for the subscription. Allowed values: * `CUSTOM_HTTPS` * `EMAIL` * `HTTPS` (deprecated; for PagerDuty endpoints, use `PAGERDUTY`) * `ORACLE_FUNCTIONS` * `PAGERDUTY` * `SLACK` * `SMS` . |
|
(required) A locator that corresponds to the subscription protocol. For example, an email address for a subscription that uses the `EMAIL` protocol, or a URL for a subscription that uses an HTTP-based protocol. HTTP-based protocols use URL endpoints that begin with \"http:\" or \"https:\". A URL cannot exceed 512 characters. Avoid entering confidential information. |
|
(optional) Metadata for the subscription. |
|
(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\"}` |
|
(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_ONS_CREATE_TOPIC_DETAILS_T Type
The configuration details for creating the topic.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ons_create_topic_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
name varchar2(32767),
compartment_id varchar2(32767),
description varchar2(32767),
freeform_tags json_element_t,
defined_tags json_element_t,
CONSTRUCTOR FUNCTION dbms_cloud_oci_ons_create_topic_details_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_ons_create_topic_details_t (
name varchar2,
compartment_id varchar2,
description varchar2,
freeform_tags json_element_t,
defined_tags json_element_t
) RETURN SELF AS RESULT
) NOT PERSISTABLE;
Fields
Field | Description |
---|---|
|
(required) The name of the topic being created. The topic name must be unique across the tenancy. Avoid entering confidential information. |
|
(required) The OCID of the compartment to create the topic in. |
|
(optional) The description of the topic being created. Avoid entering confidential information. |
|
(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\"}` |
|
(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_ONS_DELIVERY_POLICY_T Type
The subscription delivery policy.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ons_delivery_policy_t FORCE AUTHID CURRENT_USER IS OBJECT (
backoff_retry_policy dbms_cloud_oci_ons_backoff_retry_policy_t,
CONSTRUCTOR FUNCTION dbms_cloud_oci_ons_delivery_policy_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_ons_delivery_policy_t (
backoff_retry_policy dbms_cloud_oci_ons_backoff_retry_policy_t
) RETURN SELF AS RESULT
) NOT PERSISTABLE;
Fields
Field | Description |
---|---|
|
(optional) |
DBMS_CLOUD_OCI_ONS_ERROR_T Type
An error has occurred.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ons_error_t FORCE AUTHID CURRENT_USER IS OBJECT (
code varchar2(32767),
message varchar2(32767),
CONSTRUCTOR FUNCTION dbms_cloud_oci_ons_error_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_ons_error_t (
code varchar2,
message varchar2
) RETURN SELF AS RESULT
) NOT PERSISTABLE;
Fields
Field | Description |
---|---|
|
(required) A short error code that defines the error, meant for programmatic parsing. See API Errors. |
|
(required) A human-readable error string. |
DBMS_CLOUD_OCI_ONS_MESSAGE_DETAILS_T Type
The content of the message to be published.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ons_message_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
title varchar2(32767),
body varchar2(32767),
CONSTRUCTOR FUNCTION dbms_cloud_oci_ons_message_details_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_ons_message_details_t (
title varchar2,
body varchar2
) RETURN SELF AS RESULT
) NOT PERSISTABLE;
Fields
Field | Description |
---|---|
|
(optional) The title of the message to be published. Avoid entering confidential information. |
|
(required) The body of the message to be published. Avoid entering confidential information. |
DBMS_CLOUD_OCI_ONS_NOTIFICATION_TOPIC_T Type
The properties that define a topic. For general information about topics, see Notifications Overview.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ons_notification_topic_t FORCE AUTHID CURRENT_USER IS OBJECT (
name varchar2(32767),
topic_id varchar2(32767),
short_topic_id varchar2(32767),
compartment_id varchar2(32767),
lifecycle_state varchar2(32767),
description varchar2(32767),
time_created timestamp with time zone,
etag varchar2(32767),
freeform_tags json_element_t,
defined_tags json_element_t,
api_endpoint varchar2(32767),
CONSTRUCTOR FUNCTION dbms_cloud_oci_ons_notification_topic_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_ons_notification_topic_t (
name varchar2,
topic_id varchar2,
short_topic_id varchar2,
compartment_id varchar2,
lifecycle_state varchar2,
description varchar2,
time_created timestamp with time zone,
etag varchar2,
freeform_tags json_element_t,
defined_tags json_element_t,
api_endpoint varchar2
) RETURN SELF AS RESULT
) NOT PERSISTABLE;
Fields
Field | Description |
---|---|
|
(required) The name of the topic. |
|
(required) The OCID of the topic. |
|
(optional) A unique short topic Id. This is used only for SMS subscriptions. |
|
(required) The OCID of the compartment for the topic. |
|
(required) The lifecycle state of the topic. Allowed values are: 'ACTIVE', 'DELETING', 'CREATING' |
|
(optional) The description of the topic. |
|
(required) The time the topic was created. |
|
(optional) For optimistic concurrency control. See `if-match`. |
|
(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\"}` |
|
(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\"}}` |
|
(required) The endpoint for managing subscriptions or publishing messages to the topic. |
DBMS_CLOUD_OCI_ONS_NOTIFICATION_TOPIC_SUMMARY_T Type
A summary of the properties that define a topic.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ons_notification_topic_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
name varchar2(32767),
topic_id varchar2(32767),
short_topic_id varchar2(32767),
compartment_id varchar2(32767),
lifecycle_state varchar2(32767),
description varchar2(32767),
time_created timestamp with time zone,
etag varchar2(32767),
freeform_tags json_element_t,
defined_tags json_element_t,
api_endpoint varchar2(32767),
CONSTRUCTOR FUNCTION dbms_cloud_oci_ons_notification_topic_summary_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_ons_notification_topic_summary_t (
name varchar2,
topic_id varchar2,
short_topic_id varchar2,
compartment_id varchar2,
lifecycle_state varchar2,
description varchar2,
time_created timestamp with time zone,
etag varchar2,
freeform_tags json_element_t,
defined_tags json_element_t,
api_endpoint varchar2
) RETURN SELF AS RESULT
) NOT PERSISTABLE;
Fields
Field | Description |
---|---|
|
(required) The name of the topic. |
|
(required) The OCID of the topic. |
|
(optional) A unique short topic Id. This is used only for SMS subscriptions. |
|
(required) The OCID of the compartment for the topic. |
|
(required) The lifecycle state of the topic. Allowed values are: 'ACTIVE', 'DELETING', 'CREATING' |
|
(optional) The description of the topic. |
|
(required) The time the topic was created. |
|
(optional) For optimistic concurrency control. See `if-match`. |
|
(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\"}` |
|
(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\"}}` |
|
(required) The endpoint for managing subscriptions or publishing messages to the topic. |
DBMS_CLOUD_OCI_ONS_PUBLISH_RESULT_T Type
The response to a PublishMessage call.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ons_publish_result_t FORCE AUTHID CURRENT_USER IS OBJECT (
message_id varchar2(32767),
time_stamp timestamp with time zone,
CONSTRUCTOR FUNCTION dbms_cloud_oci_ons_publish_result_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_ons_publish_result_t (
message_id varchar2,
time_stamp timestamp with time zone
) RETURN SELF AS RESULT
) NOT PERSISTABLE;
Fields
Field | Description |
---|---|
|
(required) The UUID of the message. |
|
(optional) The time that the service received the message. |
DBMS_CLOUD_OCI_ONS_SUBSCRIPTION_T Type
The subscription's configuration. For general information about subscriptions, see Notifications Overview.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ons_subscription_t FORCE AUTHID CURRENT_USER IS OBJECT (
id varchar2(32767),
topic_id varchar2(32767),
protocol varchar2(32767),
endpoint varchar2(32767),
lifecycle_state varchar2(32767),
compartment_id varchar2(32767),
created_time number,
deliver_policy varchar2(32767),
etag varchar2(32767),
freeform_tags json_element_t,
defined_tags json_element_t,
CONSTRUCTOR FUNCTION dbms_cloud_oci_ons_subscription_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_ons_subscription_t (
id varchar2,
topic_id varchar2,
protocol varchar2,
endpoint varchar2,
lifecycle_state varchar2,
compartment_id varchar2,
created_time number,
deliver_policy varchar2,
etag varchar2,
freeform_tags json_element_t,
defined_tags json_element_t
) RETURN SELF AS RESULT
) NOT PERSISTABLE;
Fields
Field | Description |
---|---|
|
(required) The OCID of the subscription. |
|
(required) The OCID of the associated topic. |
|
(required) The protocol used for the subscription. Allowed values: * `CUSTOM_HTTPS` * `EMAIL` * `HTTPS` (deprecated; for PagerDuty endpoints, use `PAGERDUTY`) * `ORACLE_FUNCTIONS` * `PAGERDUTY` * `SLACK` * `SMS` . |
|
(required) A locator that corresponds to the subscription protocol. For example, an email address for a subscription that uses the `EMAIL` protocol, or a URL for a subscription that uses an HTTP-based protocol. |
|
(required) The lifecycle state of the subscription. The status of a new subscription is PENDING; when confirmed, the subscription status changes to ACTIVE. Allowed values are: 'PENDING', 'ACTIVE', 'DELETED' |
|
(required) The OCID of the compartment for the subscription. |
|
(optional) The time when this suscription was created. |
|
(optional) The delivery policy of the subscription. Stored as a JSON string. |
|
(optional) For optimistic concurrency control. See `if-match`. |
|
(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\"}` |
|
(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_ONS_SUBSCRIPTION_SUMMARY_T Type
The subscription's configuration summary.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ons_subscription_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
id varchar2(32767),
topic_id varchar2(32767),
protocol varchar2(32767),
endpoint varchar2(32767),
lifecycle_state varchar2(32767),
compartment_id varchar2(32767),
created_time number,
delivery_policy dbms_cloud_oci_ons_delivery_policy_t,
etag varchar2(32767),
freeform_tags json_element_t,
defined_tags json_element_t,
CONSTRUCTOR FUNCTION dbms_cloud_oci_ons_subscription_summary_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_ons_subscription_summary_t (
id varchar2,
topic_id varchar2,
protocol varchar2,
endpoint varchar2,
lifecycle_state varchar2,
compartment_id varchar2,
created_time number,
delivery_policy dbms_cloud_oci_ons_delivery_policy_t,
etag varchar2,
freeform_tags json_element_t,
defined_tags json_element_t
) RETURN SELF AS RESULT
) NOT PERSISTABLE;
Fields
Field | Description |
---|---|
|
(required) The OCID of the subscription. |
|
(required) The OCID of the associated topic. |
|
(required) The protocol used for the subscription. Allowed values: * `CUSTOM_HTTPS` * `EMAIL` * `HTTPS` (deprecated; for PagerDuty endpoints, use `PAGERDUTY`) * `ORACLE_FUNCTIONS` * `PAGERDUTY` * `SLACK` * `SMS` . |
|
(required) A locator that corresponds to the subscription protocol. For example, an email address for a subscription that uses the `EMAIL` protocol, or a URL for a subscription that uses an HTTP-based protocol. |
|
(required) The lifecycle state of the subscription. The status of a new subscription is PENDING; when confirmed, the subscription status changes to ACTIVE. Allowed values are: 'PENDING', 'ACTIVE', 'DELETED' |
|
(required) The OCID of the compartment for the subscription. |
|
(optional) The time when this suscription was created. |
|
(optional) |
|
(optional) For optimistic concurrency control. See `if-match`. |
|
(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\"}` |
|
(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_ONS_TOPIC_ATTRIBUTES_DETAILS_T Type
The configuration details for updating the topic.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ons_topic_attributes_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
description varchar2(32767),
freeform_tags json_element_t,
defined_tags json_element_t,
CONSTRUCTOR FUNCTION dbms_cloud_oci_ons_topic_attributes_details_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_ons_topic_attributes_details_t (
description varchar2,
freeform_tags json_element_t,
defined_tags json_element_t
) RETURN SELF AS RESULT
) NOT PERSISTABLE;
Fields
Field | Description |
---|---|
|
(required) The description of the topic. Avoid entering confidential information. |
|
(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\"}` |
|
(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_ONS_UPDATE_SUBSCRIPTION_DETAILS_T Type
The configuration details for updating the subscription.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ons_update_subscription_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
delivery_policy dbms_cloud_oci_ons_delivery_policy_t,
freeform_tags json_element_t,
defined_tags json_element_t,
CONSTRUCTOR FUNCTION dbms_cloud_oci_ons_update_subscription_details_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_ons_update_subscription_details_t (
delivery_policy dbms_cloud_oci_ons_delivery_policy_t,
freeform_tags json_element_t,
defined_tags json_element_t
) RETURN SELF AS RESULT
) NOT PERSISTABLE;
Fields
Field | Description |
---|---|
|
(optional) The delivery policy of the subscription. Stored as a JSON string. |
|
(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\"}` |
|
(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\"}}` |