ONS Notification Control Plane Functions

Package: DBMS_CLOUD_OCI_ONS_NOTIFICATION_CONTROL_PLANE

CHANGE_TOPIC_COMPARTMENT Function

Moves a topic into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment. Transactions Per Minute (TPM) per-tenancy limit for this operation: 60.

Syntax

FUNCTION change_topic_compartment (
  topic_id varchar2,
  change_topic_compartment_details dbms_cloud_oci_ons_change_compartment_details_t,
  opc_retry_token varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ons_notification_control_plane_change_topic_compartment_response_t;

Parameters

Parameter	Description
`topic_id`	(required) The OCID of the topic to move.
`change_topic_compartment_details`	(required) The configuration details for the move operation.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before that due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
`opc_request_id`	(optional) The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`if_match`	(optional) Used for optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://notification.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CREATE_TOPIC Function

Creates a topic in the specified compartment. For the purposes of access control, you must provide the OCID of the compartment where you want the topic to reside. For information about access control and compartments, see Overview of the IAM Service. You must specify a display name for the topic. All Oracle Cloud Infrastructure resources, including topics, get an Oracle-assigned, unique ID called an Oracle Cloud Identifier (OCID). When you create a resource, you can find its OCID in the response. You can also retrieve a resource's OCID by using a List API operation on that resource type, or by viewing the resource in the Console. For more information, see Resource Identifiers. Transactions Per Minute (TPM) per-tenancy limit for this operation: 60.

Syntax

FUNCTION create_topic (
  create_topic_details dbms_cloud_oci_ons_create_topic_details_t,
  opc_retry_token varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ons_notification_control_plane_create_topic_response_t;

Parameters

Parameter	Description
`create_topic_details`	(required) The topic to create.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before that due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
`opc_request_id`	(optional) The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://notification.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

DELETE_TOPIC Function

Deletes the specified topic. Transactions Per Minute (TPM) per-tenancy limit for this operation: 60.

Syntax

FUNCTION delete_topic (
  topic_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ons_notification_control_plane_delete_topic_response_t;

Parameters

Parameter	Description
`topic_id`	(required) The OCID of the topic to delete.
`opc_request_id`	(optional) The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`if_match`	(optional) Used for optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://notification.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_TOPIC Function

Gets the specified topic's configuration information.

Syntax

FUNCTION get_topic (
  topic_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ons_notification_control_plane_get_topic_response_t;

Parameters

Parameter	Description
`topic_id`	(required) The OCID of the topic to retrieve. Transactions Per Minute (TPM) per-tenancy limit for this operation: 120.
`opc_request_id`	(optional) The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://notification.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_TOPICS Function

Lists topics in the specified compartment. Transactions Per Minute (TPM) per-tenancy limit for this operation: 120.

Syntax

FUNCTION list_topics (
  compartment_id varchar2,
  id varchar2 DEFAULT NULL,
  name varchar2 DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ons_notification_control_plane_list_topics_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) The OCID of the compartment.
`id`	(optional) A filter to only return resources that match the given id exactly.
`name`	(optional) A filter to only return resources that match the given name exactly.
`page`	(optional) For list pagination. The value of the opc-next-page response header from the previous \"List\" call. For important details about how pagination works, see List Pagination.
`limit`	(optional) For list pagination. The maximum number of results per page, or items to return in a paginated \"List\" call. For important details about how pagination works, see List Pagination.
`sort_by`	(optional) The field to sort by. Only one field can be selected for sorting. Allowed values are: 'TIMECREATED', 'LIFECYCLESTATE'
`sort_order`	(optional) The sort order to use (ascending or descending). Allowed values are: 'ASC', 'DESC'
`lifecycle_state`	(optional) Filter returned list by specified lifecycle state. This parameter is case-insensitive.
`opc_request_id`	(optional) The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://notification.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_TOPIC Function

Updates the specified topic's configuration. Transactions Per Minute (TPM) per-tenancy limit for this operation: 60.

Syntax

FUNCTION update_topic (
  topic_id varchar2,
  topic_attributes_details dbms_cloud_oci_ons_topic_attributes_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ons_notification_control_plane_update_topic_response_t;

Parameters

Parameter	Description
`topic_id`	(required) The OCID of the topic to update.
`topic_attributes_details`	(required) TopicAttributes
`opc_request_id`	(optional) The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`if_match`	(optional) Used for optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://notification.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

Oracle Cloud Infrastructure Documentation

CHANGE_TOPIC_COMPARTMENT Function

CREATE_TOPIC Function

DELETE_TOPIC Function

GET_TOPIC Function

LIST_TOPICS Function

UPDATE_TOPIC Function