Package api.equinix.javasdk.messaging.client

Interface Subscriptions

All Known Implementing Classes:

SubscriptionsImpl

public interface Subscriptions

Client interface for managing Equinix Messaging subscriptions. Provides methods to list, retrieve, and create subscriptions that define which event types and resources the account receives notifications for.

Method Summary

Modifier and Type	Method	Description
SubscriptionOperator.SubscriptionBuilder	define()	Returns a builder for defining and creating a new messaging subscription.
Subscription	getByUuid(String uuid)	Retrieves a specific subscription by its unique identifier.
PaginatedList<Subscription>	list()	Lists all messaging subscriptions for the current account.

Method Details

list

PaginatedList<Subscription> list()

Lists all messaging subscriptions for the current account.

Returns:

a paginated list of subscriptions

getByUuid

Subscription getByUuid(String uuid)

Retrieves a specific subscription by its unique identifier.

Parameters:

uuid - the unique identifier of the subscription

Returns:

the subscription

define

SubscriptionOperator.SubscriptionBuilder define()

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

Returns:

a subscription builder