co.cask.cdap.notifications.feeds.service

Interface NotificationFeedStore

public interface NotificationFeedStore

Store for NotificationFeedId objects.

Method Summary

Modifier and Type	Method and Description
co.cask.cdap.proto.notification.NotificationFeedInfo	createNotificationFeed(co.cask.cdap.proto.notification.NotificationFeedInfo feed) Creates a new Notification feed.
co.cask.cdap.proto.notification.NotificationFeedInfo	deleteNotificationFeed(co.cask.cdap.proto.id.NotificationFeedId feed) Deletes a Notification feed from the metadata store.
co.cask.cdap.proto.notification.NotificationFeedInfo	getNotificationFeed(co.cask.cdap.proto.id.NotificationFeedId feed) Retrieves a Notification feed from the metadata store.
List<co.cask.cdap.proto.notification.NotificationFeedInfo>	listNotificationFeeds(co.cask.cdap.proto.id.NamespaceId namespace) Lists all registered Notification feeds for the namespace.

Method Detail

createNotificationFeed

@Nullable
co.cask.cdap.proto.notification.NotificationFeedInfo createNotificationFeed(co.cask.cdap.proto.notification.NotificationFeedInfo feed)

Creates a new Notification feed.

Parameters:

feed - NotificationFeedId representing the feed

Returns:

existing NotificationFeedId if a feed with the same id already exists, or null if no feed with the same id exists and the feed was created successfully

getNotificationFeed

@Nullable
co.cask.cdap.proto.notification.NotificationFeedInfo getNotificationFeed(co.cask.cdap.proto.id.NotificationFeedId feed)

Retrieves a Notification feed from the metadata store.

Parameters:

feed - NotificationFeedId representing the feed

Returns:

NotificationFeedId of the requested feed, or null if it was not found in the store

deleteNotificationFeed

@Nullable
co.cask.cdap.proto.notification.NotificationFeedInfo deleteNotificationFeed(co.cask.cdap.proto.id.NotificationFeedId feed)

Deletes a Notification feed from the metadata store.

Parameters:

feed - NotificationFeedId representing the feed

Returns:

NotificationFeedInfo of the feed if it was found and deleted, null if the specified feed did not exist

listNotificationFeeds

List<co.cask.cdap.proto.notification.NotificationFeedInfo> listNotificationFeeds(co.cask.cdap.proto.id.NamespaceId namespace)

Lists all registered Notification feeds for the namespace.

Parameters:

namespace - Id of the namespace to list the feeds for

Returns:

a list of all registered feeds