Interface StreamAssets

All Known Implementing Classes:
StreamAssetsImpl
public interface StreamAssets
Client interface for attaching and detaching assets (ports, connections, routers, etc.) to and from Equinix Fabric streams for telemetry.

  • Method Details

    • get

      StreamAsset get(String streamId, String asset, String assetId)
      Retrieves a single asset attached to a stream.
      Parameters:
      streamId - the unique identifier of the stream
      asset - the asset type segment (for example connections, ports, routers)
      assetId - the unique identifier of the asset
      Returns:
      the stream asset

    • attach

      StreamAsset attach(String streamId, String asset, String assetId, Boolean metricsEnabled)
      Attaches an asset to a stream (enabling telemetry).
      Parameters:
      streamId - the unique identifier of the stream
      asset - the asset type segment (for example connections, ports, routers)
      assetId - the unique identifier of the asset
      metricsEnabled - whether metrics are enabled for the attached asset
      Returns:
      the attached stream asset

    • detach

      Boolean detach(String streamId, String asset, String assetId)
      Detaches an asset from a stream.
      Parameters:
      streamId - the unique identifier of the stream
      asset - the asset type segment (for example connections, ports, routers)
      assetId - the unique identifier of the asset
      Returns:
      true if the detach was accepted

    • search

      PaginatedFilteredList<StreamAsset> search(FilterPropertyList filter, SortPropertyList sort)
      Searches stream assets (POST /fabric/v4/streamAssets/search), for example by /uuid, /streamUuid or /attachmentStatus.
      Parameters:
      filter - the filter, or null
      sort - the sort, or null
      Returns:
      a paginated, filtered list of stream assets

    • getDevice

      StreamAsset getDevice(String streamId, String deviceId)
      Retrieves a Network Edge device attached to a stream (GET /fabric/v4/streams/{streamId}/devices/{deviceId}).
      Parameters:
      streamId - the stream uuid
      deviceId - the Network Edge device uuid
      Returns:
      the device asset with its streamed interfaces

    • attachDevice

      StreamAsset attachDevice(String streamId, String deviceId, List<Integer> interfaceIds)
      Streams a Network Edge device (PUT /fabric/v4/streams/{streamId}/devices/{deviceId}). The interface ids are the complete desired set: interfaces not listed are detached.
      Parameters:
      streamId - the stream uuid
      deviceId - the Network Edge device uuid
      interfaceIds - the device interface ids to stream (non-empty)
      Returns:
      the device asset (typically ATTACHING)

    • detachDevice

      StreamAsset detachDevice(String streamId, String deviceId)
      Stops streaming a Network Edge device (DELETE /fabric/v4/streams/{streamId}/devices/{deviceId}).
      Parameters:
      streamId - the stream uuid
      deviceId - the Network Edge device uuid
      Returns:
      the device asset (typically DETACHING), or null on an empty response