Class StreamingSubscriptionsImpl

java.lang.Object

com.eqixiac.equinix.ibxsmartview.client.implementation.StreamingSubscriptionsImpl

All Implemented Interfaces:

StreamingSubscriptions

public class StreamingSubscriptionsImpl
extends Object
implements StreamingSubscriptions

Constructor Summary

Constructors

Constructor	Description
StreamingSubscriptionsImpl()

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.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

StreamingSubscriptionsImpl

public StreamingSubscriptionsImpl()

Method Details

list

public List<StreamingSubscription> list()

Description copied from interface: StreamingSubscriptions

Lists all streaming subscriptions for the current account.

Specified by:

list in interface StreamingSubscriptions

Returns:

a list of streaming subscriptions

getByUuid

public StreamingSubscription getByUuid(String uuid)

Description copied from interface: StreamingSubscriptions

Retrieves a specific streaming subscription by its unique identifier.

Specified by:

getByUuid in interface StreamingSubscriptions

Parameters:

uuid - the unique identifier of the streaming subscription

Returns:

the streaming subscription

define

public StreamingSubscriptionOperator.StreamingSubscriptionBuilder define()

Description copied from interface: StreamingSubscriptions

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

Specified by:

define in interface StreamingSubscriptions

Returns:

a streaming subscription builder

getSubscriptionData

public SubscriptionData getSubscriptionData(String subscriptionId)

Description copied from interface: StreamingSubscriptions

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

Specified by:

getSubscriptionData in interface StreamingSubscriptions

Parameters:

subscriptionId - the unique identifier of the subscription

Returns:

the subscription data

getSubscriptionData

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

Description copied from interface: StreamingSubscriptions

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

Specified by:

getSubscriptionData in interface StreamingSubscriptions

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

public SubscriptionCertificate getCertificate(String channelType)

Description copied from interface: StreamingSubscriptions

Retrieves the certificate used for authenticating a streaming channel.

Specified by:

getCertificate in interface StreamingSubscriptions

Parameters:

channelType - the type of streaming channel

Returns:

the subscription certificate