Interface StreamAssetClient<T>

All Superinterfaces:

Pageable<T>, PageablePost<T>

All Known Implementing Classes:

StreamAssetClientImpl

public interface StreamAssetClient<T>
extends PageablePost<T>

Method Summary

Modifier and Type	Method	Description
StreamAssetJson	attach(String streamId, String asset, String assetId, Boolean metricsEnabled)
StreamAssetJson	deleteDevice(String streamId, String deviceId)	DELETE /fabric/v4/streams/{streamId}/devices/{deviceId}.
StreamAssetJson	detach(String streamId, String asset, String assetId)
StreamAssetJson	get(String streamId, String asset, String assetId)
StreamAssetJson	getDevice(String streamId, String deviceId)	GET /fabric/v4/streams/{streamId}/devices/{deviceId}.
Page<StreamAssetJson>	search(FilterPropertyList filter, SortPropertyList sort)	POST /fabric/v4/streamAssets/search.
StreamAssetJson	updateDevice(String streamId, String deviceId, StreamDevicePutRequest request)	PUT /fabric/v4/streams/{streamId}/devices/{deviceId}.

Methods inherited from interface Pageable

nextPage

Modifier and Type	Method	Description
PaginatedList<T>	nextPage(PaginatedRequest<T> equinixRequest)

Methods inherited from interface PageablePost

nextPage

Modifier and Type	Method	Description
PaginatedFilteredList<T>	nextPage(PaginatedPostRequest<T> equinixRequest)	Fetches the next page for the given POST-search request (its body's pagination has already been advanced by the paging pipeline).

Method Details

get

StreamAssetJson get(String streamId,
 String asset,
 String assetId)

attach

StreamAssetJson attach(String streamId,
 String asset,
 String assetId,
 Boolean metricsEnabled)

detach

StreamAssetJson detach(String streamId,
 String asset,
 String assetId)

search

Page<StreamAssetJson> search(FilterPropertyList filter,
 SortPropertyList sort)

POST /fabric/v4/streamAssets/search.

Parameters:

filter - the filter, or null

sort - the sort, or null

Returns:

the first page

getDevice

StreamAssetJson getDevice(String streamId,
 String deviceId)

GET /fabric/v4/streams/{streamId}/devices/{deviceId}.

Parameters:

streamId - the stream uuid

deviceId - the Network Edge device uuid

Returns:

the device asset

updateDevice

StreamAssetJson updateDevice(String streamId,
 String deviceId,
 StreamDevicePutRequest request)

PUT /fabric/v4/streams/{streamId}/devices/{deviceId}.

Parameters:

streamId - the stream uuid

deviceId - the Network Edge device uuid

request - the desired interfaces

Returns:

the device asset (202)

deleteDevice

StreamAssetJson deleteDevice(String streamId,
 String deviceId)

DELETE /fabric/v4/streams/{streamId}/devices/{deviceId}.

Parameters:

streamId - the stream uuid

deviceId - the Network Edge device uuid

Returns:

the device asset (202), or null on an empty body