Interface StreamSubscriptions

All Known Implementing Classes:
StreamSubscriptionsImpl
public interface StreamSubscriptions
Client interface for managing subscriptions to Equinix Fabric event streams. Subscriptions define the sink destination where stream events are delivered.

  • Method Details

    • list

      PaginatedList<StreamSubscription> list(String streamId)
      Lists all subscriptions for the specified stream.
      Parameters:
      streamId - the unique identifier of the parent stream
      Returns:
      a paginated list of stream subscriptions

    • getByUuid

      StreamSubscription getByUuid(String streamId, String uuid)
      Retrieves a single stream subscription by its unique identifier.
      Parameters:
      streamId - the unique identifier of the parent stream
      uuid - the unique identifier of the stream subscription
      Returns:
      the stream subscription matching the given UUID

    • define

      StreamSubscriptionOperator.StreamSubscriptionBuilder define(String streamId)
      Begins the fluent builder for creating a new stream subscription. Call methods on the returned builder to configure the subscription, then call create().
      Parameters:
      streamId - the unique identifier of the parent stream
      Returns:
      a builder for configuring the new stream subscription

    • search

      PaginatedFilteredList<StreamSubscription> search(FilterPropertyList filter, SortPropertyList sort)
      Searches stream subscriptions across streams (POST /fabric/v4/streamSubscriptions/search), for example by /streamUuid, /uuid or /name.
      Parameters:
      filter - the filter (required by the spec)
      sort - the sort, or null
      Returns:
      a paginated, filtered list of stream subscriptions
      Throws:
      IllegalArgumentException - when filter is null