Interface StreamingSubscriptions
- All Known Implementing Classes:
StreamingSubscriptionsImpl
public interface StreamingSubscriptions
Client interface for managing IBX SmartView streaming subscriptions. Provides methods
to list, retrieve, and create streaming subscriptions that enable real-time delivery
of environmental and power data from monitored IBX assets.
-
Method Summary
Modifier and TypeMethodDescriptiondefine()Returns a builder for defining and creating a new streaming subscription.Retrieves a specific streaming subscription by its unique identifier.getCertificate(String channelType) Retrieves the certificate used for authenticating a streaming channel.getSubscriptionData(String subscriptionId) Retrieves the data payload associated with a specific subscription.list()Lists all streaming subscriptions for the current account.
-
Method Details
-
list
List<StreamingSubscription> list()Lists all streaming subscriptions for the current account.- Returns:
- a list of streaming subscriptions
-
getByUuid
Retrieves a specific streaming subscription by its unique identifier.- Parameters:
uuid- the unique identifier of the streaming subscription- Returns:
- the streaming subscription
-
define
Returns a builder for defining and creating a new streaming subscription.- Returns:
- a streaming subscription builder
-
getSubscriptionData
Retrieves the data payload associated with a specific subscription.- Parameters:
subscriptionId- the unique identifier of the subscription- Returns:
- the subscription data
-
getCertificate
Retrieves the certificate used for authenticating a streaming channel.- Parameters:
channelType- the type of streaming channel- Returns:
- the subscription certificate
-