NotificationDataPlaneClient¶

class oci.ons.NotificationDataPlaneClient(config, **kwargs)¶

Use the Notifications API to broadcast messages to distributed components by topic, using a publish-subscribe pattern. For information about managing topics, subscriptions, and messages, see [Notifications Overview](/iaas/Content/Notification/Concepts/notificationoverview.htm).

Methods

`__init__`(config, **kwargs)	Creates a new service client
`change_subscription_compartment`(…)	Moves a subscription into a different compartment within the same tenancy.
`create_subscription`(…)	Creates a subscription for the specified topic and sends a subscription confirmation URL to the endpoint.
`delete_subscription`(subscription_id, **kwargs)	Deletes the specified subscription.
`get_confirm_subscription`(id, token, …)	Gets the confirmation details for the specified subscription.
`get_subscription`(subscription_id, **kwargs)	Gets the specified subscription’s configuration information.
`get_unsubscription`(id, token, protocol, **kwargs)	Unsubscribes the subscription from the topic.
`list_subscriptions`(compartment_id, **kwargs)	Lists the subscriptions in the specified compartment or topic.
`publish_message`(topic_id, message_details, …)	Publishes a message to the specified topic.
`resend_subscription_confirmation`(id, **kwargs)	Resends the confirmation details for the specified subscription.
`update_subscription`(subscription_id, …)	Updates the specified subscription’s configuration.

__init__(config, **kwargs)¶

Creates a new service client

Parameters:

config (dict) – Configuration keys and values as per SDK and Tool Configuration. The from_file() method can be used to load configuration from a file. Alternatively, a dict can be passed. You can validate_config the dict using validate_config()
service_endpoint (str) – (optional) The endpoint of the service to call using this client. For example https://iaas.us-ashburn-1.oraclecloud.com. If this keyword argument is not provided then it will be derived using the region in the config parameter. You should only provide this keyword argument if you have an explicit need to specify a service endpoint.
timeout (float or tuple(float, float)) – (optional) The connection and read timeouts for the client. The default values are connection timeout 10 seconds and read timeout 60 seconds. This keyword argument can be provided as a single float, in which case the value provided is used for both the read and connection timeouts, or as a tuple of two floats. If a tuple is provided then the first value is used as the connection timeout and the second value as the read timeout.
signer (AbstractBaseSigner) –
(optional) The signer to use when signing requests made by the service client. The default is to use a Signer based on the values provided in the config parameter.

One use case for this parameter is for Instance Principals authentication by passing an instance of InstancePrincipalsSecurityTokenSigner as the value for this keyword argument
retry_strategy (obj) –
(optional) A retry strategy to apply to all calls made by this service client (i.e. at the client level). There is no retry strategy applied by default. Retry strategies can also be applied at the operation level by passing a retry_strategy keyword argument as part of calling the operation. Any value provided at the operation level will override whatever is specified at the client level.

This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.
circuit_breaker_strategy (obj) – (optional) A circuit breaker strategy to apply to all calls made by this service client (i.e. at the client level). This client uses DEFAULT_CIRCUIT_BREAKER_STRATEGY as default if no circuit breaker strategy is provided. The specifics of circuit breaker strategy are described here.
circuit_breaker_callback (function) – (optional) Callback function to receive any exceptions triggerred by the circuit breaker.
allow_control_chars – (optional) allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object.

change_subscription_compartment(subscription_id, change_subscription_compartment_details, **kwargs)¶

Moves a subscription 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.

Parameters:	subscription_id (str) – (required) The OCID of the subscription to move. change_subscription_compartment_details (oci.ons.models.ChangeCompartmentDetails) – (required) The configuration details for the move operation. opc_retry_token (str) – (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 (str) – (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 (str) – (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. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use change_subscription_compartment API.

create_subscription(create_subscription_details, **kwargs)¶

Creates a subscription for the specified topic and sends a subscription confirmation URL to the endpoint. The subscription remains in “Pending” status until it has been confirmed. For information about confirming subscriptions, see To confirm a subscription.

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

Parameters:	create_subscription_details (oci.ons.models.CreateSubscriptionDetails) – (required) The subscription to create. opc_retry_token (str) – (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 (str) – (optional) The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `Subscription`
Return type:	`Response`
Example:

Click here to see an example of how to use create_subscription API.

delete_subscription(subscription_id, **kwargs)¶

Deletes the specified subscription.

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

Parameters:	subscription_id (str) – (required) The OCID of the subscription to delete. opc_request_id (str) – (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 (str) – (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. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use delete_subscription API.

get_confirm_subscription(id, token, protocol, **kwargs)¶

Gets the confirmation details for the specified subscription.

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

Parameters:	id (str) – (required) The OCID of the subscription to get the confirmation details for. token (str) – (required) The subscription confirmation token. protocol (str) – (required) The protocol used for the subscription. Allowed values: CUSTOM_HTTPS EMAIL HTTPS (deprecated; for PagerDuty endpoints, use PAGERDUTY) ORACLE_FUNCTIONS PAGERDUTY SLACK SMS For information about subscription protocols, see To create a subscription. opc_request_id (str) – (optional) The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `ConfirmationResult`
Return type:	`Response`
Example:

Click here to see an example of how to use get_confirm_subscription API.

get_subscription(subscription_id, **kwargs)¶

Gets the specified subscription’s configuration information.

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

Parameters:	subscription_id (str) – (required) The OCID of the subscription to retrieve. opc_request_id (str) – (optional) The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `Subscription`
Return type:	`Response`
Example:

Click here to see an example of how to use get_subscription API.

get_unsubscription(id, token, protocol, **kwargs)¶

Unsubscribes the subscription from the topic.

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

Parameters:	id (str) – (required) The OCID of the subscription to unsubscribe from. token (str) – (required) The subscription confirmation token. protocol (str) – (required) The protocol used for the subscription. Allowed values: CUSTOM_HTTPS EMAIL HTTPS (deprecated; for PagerDuty endpoints, use PAGERDUTY) ORACLE_FUNCTIONS PAGERDUTY SLACK SMS For information about subscription protocols, see To create a subscription. opc_request_id (str) – (optional) The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type str
Return type:	`Response`
Example:

Click here to see an example of how to use get_unsubscription API.

list_subscriptions(compartment_id, **kwargs)¶

Lists the subscriptions in the specified compartment or topic.

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

Parameters:	compartment_id (str) – (required) The OCID of the compartment. topic_id (str) – (optional) Return all subscriptions that are subscribed to the given topic OCID. Either this query parameter or the compartmentId query parameter must be set. page (str) – (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 (int) – (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. opc_request_id (str) – (optional) The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type list of `SubscriptionSummary`
Return type:	`Response`
Example:

Click here to see an example of how to use list_subscriptions API.

publish_message(topic_id, message_details, **kwargs)¶

Publishes a message to the specified topic.

The topic endpoint is required for this operation. To get the topic endpoint, use get_topic() and review the apiEndpoint value in the response (NotificationTopic).

Limits information follows.

Message size limit per request: 64KB.

Message delivery rate limit per endpoint: 60 messages per minute for HTTP-based protocols, 10 messages per minute for the EMAIL protocol. HTTP-based protocols use URL endpoints that begin with “http:” or “https:”.

Transactions Per Minute (TPM) per-tenancy limit for this operation: 60 per topic. (This TPM limit represents messages per minute.)

For more information about publishing messages, see Publishing Messages. For steps to request a limit increase, see Requesting a Service Limit Increase.

Parameters:	topic_id (str) – (required) The OCID of the topic. message_details (oci.ons.models.MessageDetails) – (required) The message to publish. opc_request_id (str) – (optional) The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. message_type (str) – (optional) Deprecated. Support for JSON is deprecated. You can send a JSON payload even when transmitting the payload as a raw string. Configure your receiving system to read the raw payload as JSON format. Type of message body in the request. For messageType of JSON, a default key-value pair is required. Example: {“default”: “Alarm breached”, “Email”: “Alarm breached: <url>”}. Allowed values are: “JSON”, “RAW_TEXT” retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `PublishResult`
Return type:	`Response`
Example:

Click here to see an example of how to use publish_message API.

resend_subscription_confirmation(id, **kwargs)¶

Resends the confirmation details for the specified subscription.

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

Parameters:	id (str) – (required) The OCID of the subscription to resend the confirmation for. opc_request_id (str) – (optional) The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `Subscription`
Return type:	`Response`
Example:

Click here to see an example of how to use resend_subscription_confirmation API.

update_subscription(subscription_id, update_subscription_details, **kwargs)¶

Updates the specified subscription’s configuration.

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

Parameters:	subscription_id (str) – (required) The OCID of the subscription to update. update_subscription_details (oci.ons.models.UpdateSubscriptionDetails) – (required) The configuration details for updating the subscription. opc_request_id (str) – (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 (str) – (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. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `UpdateSubscriptionDetails`
Return type:	`Response`
Example:

Click here to see an example of how to use update_subscription API.