Package api.equinix.javasdk

Class Messaging

java.lang.Object

api.equinix.javasdk.EquinixClient

api.equinix.javasdk.Messaging

All Implemented Interfaces:

Service, Closeable, AutoCloseable

public final class Messaging
extends EquinixClient
implements Service

The primary entry point for accessing Equinix Messaging APIs.

Messaging provides notification and event management capabilities for Equinix platform resources. This class offers typed access to notification subscriptions and event streams that enable automated workflows and monitoring.

All resource accessors use lazy initialization — internal clients are created on first access and reused for subsequent calls.

Quick Start

 BasicEquinixCredentials credentials = new BasicEquinixCredentials("clientId", "clientSecret");
 Messaging messaging = new Messaging(credentials);

 // List notification subscriptions
 PaginatedList<Subscription> subs = messaging.subscriptions().list();

 // List events
 PaginatedList<Event> events = messaging.events().list();
 

Author:

ianjones

See Also:

• BasicEquinixCredentials

Field Summary

Fields inherited from class api.equinix.javasdk.EquinixClient

equinixClient

Constructor Summary

Constructors

Constructor	Description
Messaging(EquinixCredentials equinixCredentials)	Creates a new Messaging client using the provided credentials.
Messaging(EquinixCredentials equinixCredentials, boolean isSandBoxed)	Creates a new Messaging client with optional sandbox mode.

Method Summary

Modifier and Type	Method	Description
Events	events()	Returns the client for accessing messaging events.
Subscriptions	subscriptions()	Returns the client for managing notification subscriptions.

Methods inherited from class api.equinix.javasdk.EquinixClient

authenticate, close, core

Methods inherited from class java.lang.Object

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

Constructor Details

Messaging

public Messaging(EquinixCredentials equinixCredentials)

Creates a new Messaging client using the provided credentials. Authentication occurs automatically on the first API call.

Parameters:

equinixCredentials - the OAuth2 credentials for authenticating with Equinix APIs

Messaging

public Messaging(EquinixCredentials equinixCredentials,
 boolean isSandBoxed)

Creates a new Messaging client with optional sandbox mode.

Parameters:

equinixCredentials - the OAuth2 credentials for authenticating with Equinix APIs

isSandBoxed - true to use the sandbox environment for testing; false for production

Method Details

subscriptions

public Subscriptions subscriptions()

Returns the client for managing notification subscriptions. Subscriptions define which events trigger notifications and how they are delivered.

Returns:

the Subscriptions client for creating and managing notification subscriptions

events

public Events events()

Returns the client for accessing messaging events. Events represent notifications and messages generated by Equinix platform operations.

Returns:

the Events client for listing and querying messaging events