Interface CloudEvents

All Known Implementing Classes:
CloudEventsImpl
public interface CloudEvents
Client interface for Equinix Fabric cloud events (POST /fabric/v4/cloudevents/search, GET /fabric/v4/cloudevents/{id}) and live events (POST /fabric/v4/liveEvents/search, the last operational event per subject, used for project-level active alerts).

The per-asset GET /{asset}/{id}/cloudevents endpoint is deprecated in spec 4.34.0 and is no longer called; use CloudEventQuery.forAsset(String, String).

  • Method Details

    • search

      PaginatedFilteredList<CloudEvent> search(CloudEventQuery query)
      Searches cloud events with a filter built by a CloudEventQuery.
      Parameters:
      query - the query (scoped by subject, project or organization)
      Returns:
      a paginated, filtered list of matching cloud events

    • search

      PaginatedFilteredList<CloudEvent> search(CloudEventQuery query, SortPropertyList sort)
      Searches cloud events with a CloudEventQuery and a sort order.
      Parameters:
      query - the query
      sort - the sort criteria, or null
      Returns:
      a paginated, filtered list of matching cloud events

    • search

      PaginatedFilteredList<CloudEvent> search(FilterPropertyList filter, SortPropertyList sort)
      Searches cloud events with a hand-built filter.
      Parameters:
      filter - the filter; it must contain /subject, /equinixproject or /equinixorganization
      sort - the sort criteria, or null
      Returns:
      a paginated, filtered list of matching cloud events
      Throws:
      IllegalArgumentException - when the filter has no scope expression

    • getByUuid

      CloudEvent getByUuid(String uuid)
      Retrieves a single cloud event by its unique identifier.
      Parameters:
      uuid - the unique identifier of the cloud event
      Returns:
      the cloud event matching the given UUID

    • searchLiveEvents

      PaginatedFilteredList<CloudEvent> searchLiveEvents(String... subjects)
      Returns the last operational event of each given subject (POST /fabric/v4/liveEvents/search), for example the current port-status alert.

      Live behaviour (observed 2026-11-11): exact subjects such as /fabric/v4/ports/{uuid} work with IN; an empty filter answers HTTP 500 and a wildcard subject is rejected, so at least one exact subject is required.

      Parameters:
      subjects - the exact subject paths (at least one)
      Returns:
      a paginated, filtered list of the live events