Announcements Subscription Functions

Package: DBMS_CLOUD_OCI_AS_ANNOUNCEMENT_SUBSCRIPTION

CHANGE_ANNOUNCEMENT_SUBSCRIPTION_COMPARTMENT Function

Moves the specified announcement subscription from one compartment to another compartment. When provided, If-Match is checked against ETag values of the resource. This call is subject to an Announcements limit that applies to the total number of requests across all read or write operations. Announcements might throttle this call to reject an otherwise valid request when the total rate of operations exceeds 20 requests per second for a given user. The service might also throttle this call to reject an otherwise valid request when the total rate of operations exceeds 100 requests per second for a given tenancy.

Syntax

FUNCTION change_announcement_subscription_compartment (
  announcement_subscription_id varchar2,
  change_announcement_subscription_compartment_details dbms_cloud_oci_announcements_service_change_announcement_subscription_compartment_details_t,
  if_match 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_as_announcement_subscription_change_announcement_subscription_compartment_response_t;

Parameters

Parameter	Description
`announcement_subscription_id`	(required) The OCID of the announcement subscription.
`change_announcement_subscription_compartment_details`	(required) The compartment information to update.
`if_match`	(optional) The locking version, used for optimistic concurrency control.
`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 complete 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://announcements.{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_ANNOUNCEMENT_SUBSCRIPTION Function

Creates a new announcement subscription. This call is subject to an Announcements limit that applies to the total number of requests across all read or write operations. Announcements might throttle this call to reject an otherwise valid request when the total rate of operations exceeds 20 requests per second for a given user. The service might also throttle this call to reject an otherwise valid request when the total rate of operations exceeds 100 requests per second for a given tenancy.

Syntax

FUNCTION create_announcement_subscription (
  create_announcement_subscription_details dbms_cloud_oci_announcements_service_create_announcement_subscription_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_as_announcement_subscription_create_announcement_subscription_response_t;

Parameters

Parameter	Description
`create_announcement_subscription_details`	(required) Details of the new announcement subscription.
`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 then 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 might 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 complete 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://announcements.{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_FILTER_GROUP Function

Creates a new filter group in the specified announcement subscription. This call is subject to an Announcements limit that applies to the total number of requests across all read or write operations. Announcements might throttle this call to reject an otherwise valid request when the total rate of operations exceeds 20 requests per second for a given user. The service might also throttle this call to reject an otherwise valid request when the total rate of operations exceeds 100 requests per second for a given tenancy.

Syntax

FUNCTION create_filter_group (
  announcement_subscription_id varchar2,
  create_filter_group_details dbms_cloud_oci_announcements_service_create_filter_group_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_as_announcement_subscription_create_filter_group_response_t;

Parameters

Parameter	Description
`announcement_subscription_id`	(required) The OCID of the announcement subscription.
`create_filter_group_details`	(required) Details of the new filter group.
`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 then 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 might 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 complete request ID.
`if_match`	(optional) The locking version, used for optimistic concurrency control.
`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://announcements.{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_ANNOUNCEMENT_SUBSCRIPTION Function

Deletes the specified announcement subscription. This call is subject to an Announcements limit that applies to the total number of requests across all read or write operations. Announcements might throttle this call to reject an otherwise valid request when the total rate of operations exceeds 20 requests per second for a given user. The service might also throttle this call to reject an otherwise valid request when the total rate of operations exceeds 100 requests per second for a given tenancy.

Syntax

FUNCTION delete_announcement_subscription (
  announcement_subscription_id varchar2,
  if_match 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_as_announcement_subscription_delete_announcement_subscription_response_t;

Parameters

Parameter	Description
`announcement_subscription_id`	(required) The OCID of the announcement subscription.
`if_match`	(optional) The locking version, used for optimistic concurrency control.
`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 complete 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://announcements.{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_FILTER_GROUP Function

Deletes a filter group in the specified announcement subscription. This call is subject to an Announcements limit that applies to the total number of requests across all read or write operations. Announcements might throttle this call to reject an otherwise valid request when the total rate of operations exceeds 20 requests per second for a given user. The service might also throttle this call to reject an otherwise valid request when the total rate of operations exceeds 100 requests per second for a given tenancy.

Syntax

FUNCTION delete_filter_group (
  announcement_subscription_id varchar2,
  filter_group_name 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_as_announcement_subscription_delete_filter_group_response_t;

Parameters

Parameter	Description
`announcement_subscription_id`	(required) The OCID of the announcement subscription.
`filter_group_name`	(required) The name of the filter group.
`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 complete request ID.
`if_match`	(optional) The locking version, used for optimistic concurrency control.
`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://announcements.{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_ANNOUNCEMENT_SUBSCRIPTION Function

Gets the specified announcement subscription. This call is subject to an Announcements limit that applies to the total number of requests across all read or write operations. Announcements might throttle this call to reject an otherwise valid request when the total rate of operations exceeds 20 requests per second for a given user. The service might also throttle this call to reject an otherwise valid request when the total rate of operations exceeds 100 requests per second for a given tenancy.

Syntax

FUNCTION get_announcement_subscription (
  announcement_subscription_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_as_announcement_subscription_get_announcement_subscription_response_t;

Parameters

Parameter	Description
`announcement_subscription_id`	(required) The OCID of the announcement subscription.
`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 complete 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://announcements.{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_ANNOUNCEMENT_SUBSCRIPTIONS Function

Gets a list of all announcement subscriptions in the specified compartment. This call is subject to an Announcements limit that applies to the total number of requests across all read or write operations. Announcements might throttle this call to reject an otherwise valid request when the total rate of operations exceeds 20 requests per second for a given user. The service might also throttle this call to reject an otherwise valid request when the total rate of operations exceeds 100 requests per second for a given tenancy.

Syntax

FUNCTION list_announcement_subscriptions (
  compartment_id varchar2,
  lifecycle_state varchar2 DEFAULT NULL,
  display_name varchar2 DEFAULT NULL,
  id varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by 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_as_announcement_subscription_list_announcement_subscriptions_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) The OCID of the compartment.
`lifecycle_state`	(optional) A filter to return only announcement subscriptions that match the given lifecycle state.
`display_name`	(optional) A filter to return only resources that match the entire display name given.
`id`	(optional) The OCID of the announcement subscription.
`limit`	(optional) The maximum number of items to return in a paginated \"List\" call.
`page`	(optional) The value of the `opc-next-page` response header from the previous \"List\" call.
`sort_order`	(optional) The sort order to use, whether ascending ('ASC') or descending ('DESC'). Allowed values are: 'ASC', 'DESC'
`sort_by`	(optional) The criteria to sort by. You can specify only one sort order. The default sort order for the creation date of resources is descending. The default sort order for display names is ascending. Allowed values are: 'timeCreated', 'displayName'
`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 complete 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://announcements.{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_ANNOUNCEMENT_SUBSCRIPTION Function

Updates the specified announcement subscription. This call is subject to an Announcements limit that applies to the total number of requests across all read or write operations. Announcements might throttle this call to reject an otherwise valid request when the total rate of operations exceeds 20 requests per second for a given user. The service might also throttle this call to reject an otherwise valid request when the total rate of operations exceeds 100 requests per second for a given tenancy.

Syntax

FUNCTION update_announcement_subscription (
  announcement_subscription_id varchar2,
  update_announcement_subscription_details dbms_cloud_oci_announcements_service_update_announcement_subscription_details_t,
  if_match 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_as_announcement_subscription_update_announcement_subscription_response_t;

Parameters

Parameter	Description
`announcement_subscription_id`	(required) The OCID of the announcement subscription.
`update_announcement_subscription_details`	(required) The subscription information to update.
`if_match`	(optional) The locking version, used for optimistic concurrency control.
`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 complete 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://announcements.{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_FILTER_GROUP Function

Updates a filter group in the specified announcement subscription. This call is subject to an Announcements limit that applies to the total number of requests across all read or write operations. Announcements might throttle this call to reject an otherwise valid request when the total rate of operations exceeds 20 requests per second for a given user. The service might also throttle this call to reject an otherwise valid request when the total rate of operations exceeds 100 requests per second for a given tenancy.

Syntax

FUNCTION update_filter_group (
  announcement_subscription_id varchar2,
  filter_group_name varchar2,
  update_filter_group_details dbms_cloud_oci_announcements_service_update_filter_group_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_as_announcement_subscription_update_filter_group_response_t;

Parameters

Parameter	Description
`announcement_subscription_id`	(required) The OCID of the announcement subscription.
`filter_group_name`	(required) The name of the filter group.
`update_filter_group_details`	(required) The filter group information to update.
`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 complete request ID.
`if_match`	(optional) The locking version, used for optimistic concurrency control.
`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://announcements.{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_ANNOUNCEMENT_SUBSCRIPTION_COMPARTMENT Function 🔗

CREATE_ANNOUNCEMENT_SUBSCRIPTION Function 🔗

CREATE_FILTER_GROUP Function 🔗

DELETE_ANNOUNCEMENT_SUBSCRIPTION Function 🔗

DELETE_FILTER_GROUP Function 🔗

GET_ANNOUNCEMENT_SUBSCRIPTION Function 🔗

LIST_ANNOUNCEMENT_SUBSCRIPTIONS Function 🔗

UPDATE_ANNOUNCEMENT_SUBSCRIPTION Function 🔗

UPDATE_FILTER_GROUP Function 🔗

CHANGE_ANNOUNCEMENT_SUBSCRIPTION_COMPARTMENT Function

CREATE_ANNOUNCEMENT_SUBSCRIPTION Function

CREATE_FILTER_GROUP Function

DELETE_ANNOUNCEMENT_SUBSCRIPTION Function

DELETE_FILTER_GROUP Function

GET_ANNOUNCEMENT_SUBSCRIPTION Function

LIST_ANNOUNCEMENT_SUBSCRIPTIONS Function

UPDATE_ANNOUNCEMENT_SUBSCRIPTION Function

UPDATE_FILTER_GROUP Function