Interface Notification
- All Known Implementing Classes:
NotificationImpl
public interface Notification
Interface for defining OCI logging module.
-
Method Summary
Modifier and TypeMethodDescriptioncom.oracle.bmc.ons.responses.CreateSubscriptionResponsecreateSubscription(String compartmentId, String topicId, String protocol, String endpoint) Create a Notification subscription in a Topic.com.oracle.bmc.ons.responses.CreateTopicResponsecreateTopic(String topicName, String compartmentId) Create an OCI Notification Topic.com.oracle.bmc.ons.NotificationControlPlaneDirect instance of OCI Java SDK NotificationControlPlane Client.com.oracle.bmc.ons.NotificationDataPlaneDirect instance of OCI Java SDK NotificationDataPlane Client.getSubscription(String subscriptionId) Get the Subscription Resource JSON as a String.listSubscriptions(String topicId, String compartmentId) List subscriptions in a Topic as a JSON String.com.oracle.bmc.ons.responses.PublishMessageResponsepublishMessage(String topicId, String title, String message) Publish a message to a Topic.
-
Method Details
-
getNotificationDataPlaneClient
com.oracle.bmc.ons.NotificationDataPlane getNotificationDataPlaneClient()Direct instance of OCI Java SDK NotificationDataPlane Client.- Returns:
- NotificationDataPlane
-
getNotificationControlPlaneClient
com.oracle.bmc.ons.NotificationControlPlane getNotificationControlPlaneClient()Direct instance of OCI Java SDK NotificationControlPlane Client.- Returns:
- NotificationControlPlane
-
publishMessage
com.oracle.bmc.ons.responses.PublishMessageResponse publishMessage(String topicId, String title, String message) Publish a message to a Topic.- Parameters:
topicId- OCID of the topictitle- Message titlemessage- Message content- Returns:
- PublishMessageResponse
-
createSubscription
com.oracle.bmc.ons.responses.CreateSubscriptionResponse createSubscription(String compartmentId, String topicId, String protocol, String endpoint) Create a Notification subscription in a Topic.- Parameters:
compartmentId- Compartment OCID where the Subscription needs to be createdtopicId- Topic OCID where the Subscription needs to be createdprotocol- Subscription type. Ex: EMAILendpoint- Subscription endpoint. Ex: Email ID in case of EMAIL as protocol- Returns:
- CreateSubscriptionResponse
-
getSubscription
Get the Subscription Resource JSON as a String.- Parameters:
subscriptionId- OCID of the subscription- Returns:
- String
-
listSubscriptions
List subscriptions in a Topic as a JSON String.- Parameters:
topicId- Topic OCID where to list the SubscriptionscompartmentId- Compartment OCID where the topic is present- Returns:
- String
-
createTopic
com.oracle.bmc.ons.responses.CreateTopicResponse createTopic(String topicName, String compartmentId) Create an OCI Notification Topic.- Parameters:
topicName- Name of the Topic to be createdcompartmentId- Compartment OCID where the Topic needs to be created- Returns:
- CreateTopicResponse
-