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.

Entitlement. Streaming subscriptions deliver IBX SmartView API+ near-real-time data (the spec's term for /smartview/v2/streaming/subscriptionData). API+ is a paid IBX SmartView entitlement on the account; without it these calls are rejected (typically HTTP 403), even when the read-only SmartView APIs work for the same account.

Method Summary

Modifier and Type	Method	Description
StreamingSubscriptionOperator.StreamingSubscriptionBuilder	define()	Returns a builder for defining and creating a new streaming subscription.
StreamingSubscription	getByUuid(String uuid)	Retrieves a specific streaming subscription by its unique identifier.
SubscriptionCertificate	getCertificate(String channelType)	Retrieves the certificate used for authenticating a streaming channel.
SubscriptionData	getSubscriptionData(String subscriptionId)	Retrieves the near real-time data associated with a specific subscription.
SubscriptionData	getSubscriptionData(String subscriptionId, List<String> ibxs, List<String> messageTypes, List<String> streamIds, Integer offset, Integer limit)	Retrieves the near real-time data associated with a specific subscription, narrowed by the given filters and pagination.
List<StreamingSubscription>	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

StreamingSubscription getByUuid(String uuid)

Retrieves a specific streaming subscription by its unique identifier.

Parameters:

uuid - the unique identifier of the streaming subscription

Returns:

the streaming subscription

define

StreamingSubscriptionOperator.StreamingSubscriptionBuilder define()

Returns a builder for defining and creating a new streaming subscription.

Returns:

a streaming subscription builder

getSubscriptionData

SubscriptionData getSubscriptionData(String subscriptionId)

Retrieves the near real-time data associated with a specific subscription.

Parameters:

subscriptionId - the unique identifier of the subscription

Returns:

the subscription data

getSubscriptionData

SubscriptionData getSubscriptionData(String subscriptionId,
 List<String> ibxs,
 List<String> messageTypes,
 List<String> streamIds,
 Integer offset,
 Integer limit)

Retrieves the near real-time data associated with a specific subscription, narrowed by the given filters and pagination.

Parameters:

subscriptionId - the unique identifier of the subscription

ibxs - filter to the given set of IBXs, or null for all

messageTypes - filter to the given message types (ALARM, ALERT, ENVIRONMENTAL, METERED_POWER, POWER, TAG_POINT), or null for all

streamIds - filter to the given set of stream IDs, or null for all

offset - the zero-based offset of the first item, or null for the default

limit - the maximum number of items to return, or null for the default (250)

Returns:

the subscription data

getCertificate

SubscriptionCertificate getCertificate(String channelType)

Retrieves the certificate used for authenticating a streaming channel.

Parameters:

channelType - the type of streaming channel

Returns:

the subscription certificate