Oracle Cloud Infrastructure Documentation
Try Free Tier

Announcements Preferences Functions

Package: DBMS_CLOUD_OCI_AS_ANNOUNCEMENTS_PREFERENCES

CREATE_ANNOUNCEMENTS_PREFERENCE Function

Creates a request that specifies preferences for the tenancy regarding receiving announcements by email. 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_announcements_preference (
  announcements_preference_details dbms_cloud_oci_announcements_service_create_announcements_preferences_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_as_announcements_preferences_create_announcements_preference_response_t;

Parameters

Parameter Description

announcements_preference_details

(required) The object that contains details about tenancy preferences for receiving announcements by email.

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.

opc_retry_token

(optional) Idempotency token

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_ANNOUNCEMENTS_PREFERENCE Function

Gets the current preferences of the tenancy regarding receiving announcements by email. 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_announcements_preference (
  preference_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_announcements_preferences_get_announcements_preference_response_t;

Parameters

Parameter Description

preference_id

(required) The ID of the preference.

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_ANNOUNCEMENTS_PREFERENCES Function

Gets the current preferences of the tenancy regarding receiving announcements by email. 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_announcements_preferences (
  compartment_id varchar2,
  limit number DEFAULT NULL,
  page 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_announcements_preferences_list_announcements_preferences_response_t;

Parameters

Parameter Description

compartment_id

(required) The OCID of the compartment.

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.

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_ANNOUNCEMENTS_PREFERENCE Function

Updates the preferences of the tenancy regarding receiving announcements by email. 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_announcements_preference (
  preference_id varchar2,
  announcements_preference_details dbms_cloud_oci_announcements_service_update_announcements_preferences_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_announcements_preferences_update_announcements_preference_response_t;

Parameters

Parameter Description

preference_id

(required) The ID of the preference.

announcements_preference_details

(required) The object that contains details about tenancy preferences for receiving announcements by email.

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.

Was this article helpful?