Class StreamAssetClientImpl

java.lang.Object

com.eqixiac.equinix.core.client.ClientBase

com.eqixiac.equinix.core.client.ResourceClientBase<StreamAsset, StreamAssetJson>

com.eqixiac.equinix.fabric.client.internal.implementation.StreamAssetClientImpl

All Implemented Interfaces:

Pageable<StreamAsset>, PageablePost<StreamAsset>, StreamAssetClient<StreamAsset>

public class StreamAssetClientImpl
extends ResourceClientBase<StreamAsset, StreamAssetJson>
implements StreamAssetClient<StreamAsset>

Internal client for Fabric Stream Assets (attach / detach / get an asset to/from a stream). The endpoints are keyed by stream id, asset type and asset id, with no list operation, so this client reads/writes the StreamAssetJson singleton directly.

Author:

ianjones

Nested Class Summary

Nested classes/interfaces inherited from class ClientBase

ClientBase.EquinixRequestBuilder

Modifier and Type	Class	Description
protected class	ClientBase.EquinixRequestBuilder	Fluent builder for constructing EquinixRequest instances.

Constructor Summary

Constructors

Constructor	Description
StreamAssetClientImpl(FabricConfigImpl configClient)

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}.
protected StreamAsset	wrap(StreamAssetJson json)	Wraps a JSON model into its public model type, binding this client so the returned object can refresh/delete/page itself.

Methods inherited from class ResourceClientBase

createOne, deleteOne, deleteOne, deleteOneByUuid, dryRunCreate, dryRunCreate, dryRunPatch, dryRunUpdate, getOne, getOne, getOneByUuid, listPage, listPage, listPage, listPagePath, nextPage, nextPage, patchOne, patchOne, postOne, postOne, postOne, searchPage, searchPage, searchPageQueryPaginated, searchPageQueryPaginated, updateOne, updateOne, updateOneByUuid

Modifier and Type	Method	Description
protected StreamAssetJson	createOne(Object creatorBody)	create(body) via the derived Create<Singular> endpoint name.
protected StreamAssetJson	deleteOne(String serviceEndpoint, String uuid)
protected StreamAssetJson	deleteOne(String serviceEndpoint, Map<String,String> pathParams)
protected StreamAssetJson	deleteOneByUuid(String uuid)	delete(uuid) via the derived Delete<Singular> endpoint name.
protected StreamAssetJson	dryRunCreate(String serviceEndpoint, Object body)
protected StreamAssetJson	dryRunCreate(String serviceEndpoint, Object body, com.fasterxml.jackson.databind.ser.FilterProvider filters)
protected StreamAssetJson	dryRunPatch(String serviceEndpoint, String uuid, List<PatchOperation> operations)	Dry-run variant of ResourceClientBase.patchOne(String, String, List): sends the identical RFC 6902 JSON Patch request (same application/json-patch+json content type) plus the dryRun=true query parameter - per the spec, an "option to verify that API calls will succeed".
protected StreamAssetJson	dryRunUpdate(String serviceEndpoint, String uuid, Object body)	Dry-run variant of ResourceClientBase.updateOne(String, String, Object): sends the identical update request (same default application/json content type) plus the dryRun=true query parameter - per the spec, an "option to verify that API calls will succeed".
protected StreamAssetJson	getOne(String serviceEndpoint, String uuid)
protected StreamAssetJson	getOne(String serviceEndpoint, Map<String,String> pathParams)
protected StreamAssetJson	getOneByUuid(String uuid)	get(uuid) via the derived Get<Singular> endpoint name.
protected Page<StreamAssetJson>	listPage()	list() via the derived List<Plural> endpoint name.
protected Page<StreamAssetJson>	listPage(String serviceEndpoint)
protected Page<StreamAssetJson>	listPage(String serviceEndpoint, Map<String, List<String>> queryParams)
protected Page<StreamAssetJson>	listPagePath(String serviceEndpoint, Map<String,String> pathParams)
PaginatedFilteredList<StreamAsset>	nextPage(PaginatedPostRequest<StreamAsset> equinixRequest)	Fetches the next page for the given POST-search request (its body's pagination has already been advanced by the paging pipeline).
PaginatedList<StreamAsset>	nextPage(PaginatedRequest<StreamAsset> equinixRequest)
protected StreamAssetJson	patchOne(String serviceEndpoint, String uuid, List<PatchOperation> operations)	PATCH a resource by uuid with an RFC 6902 JSON Patch operations array, sent with content-type application/json-patch+json.
protected StreamAssetJson	patchOne(String serviceEndpoint, Map<String,String> pathParams, List<PatchOperation> operations)
protected StreamAssetJson	postOne(String serviceEndpoint, Object creatorBody)
protected StreamAssetJson	postOne(String serviceEndpoint, Object body, com.fasterxml.jackson.databind.ser.FilterProvider filters)
protected StreamAssetJson	postOne(String serviceEndpoint, Map<String,String> pathParams, Object body)
protected Page<StreamAssetJson>	searchPage(Object filterSortBody)	search(body) via the derived Search<Plural> endpoint name.
protected Page<StreamAssetJson>	searchPage(String serviceEndpoint, Object filterSortBody)
protected Page<StreamAssetJson>	searchPageQueryPaginated(String serviceEndpoint, Object filterBody)	POST search whose pagination travels as offset/limit query parameters (per the endpoint's spec) rather than inside the body - e.g. assets v1 and the EIA services/prices searches.
protected Page<StreamAssetJson>	searchPageQueryPaginated(String serviceEndpoint, Map<String, List<String>> queryParams, Object filterBody)	Variant of ResourceClientBase.searchPageQueryPaginated(String, Object) carrying additional query parameters (e.g.
protected StreamAssetJson	updateOne(String serviceEndpoint, String uuid, Object body)
protected StreamAssetJson	updateOne(String serviceEndpoint, Map<String,String> pathParams, Object body)
protected StreamAssetJson	updateOneByUuid(String uuid, Object body)	update(uuid, body) via the derived Update<Singular> endpoint name.

Methods inherited from class ClientBase

booleanOp, buildRequest, buildRequest, buildRequestWithPathParams, buildRequestWithQueryParams, bytesOp, createReturningLocationUuid, getAs, getAs, getConfigClient, invoke, listAs, mapOp, newRequest, postAs, postForType, postForType, postForType, postListAs, stringOp, voidOp

Modifier and Type	Method	Description
protected boolean	booleanOp(String serviceEndpoint, RequestType requestType, Map<String,String> pathParams, Map<String, List<String>> queryParams, Object body)
protected <T> EquinixRequest<T>	buildRequest(String serviceEndpoint, RequestType requestType, Class<?> jsonClass)
protected <T> EquinixRequest<T>	buildRequest(String serviceEndpoint, RequestType requestType, Map<String,String> pathParams, Map<String, List<String>> queryParams, Class<?> jsonClass)
protected <T> EquinixRequest<T>	buildRequestWithPathParams(String serviceEndpoint, RequestType requestType, Map<String,String> pathParams, Class<?> jsonClass)
protected <T> EquinixRequest<T>	buildRequestWithQueryParams(String serviceEndpoint, RequestType requestType, Map<String, List<String>> queryParams, Class<?> jsonClass)
protected byte[]	bytesOp(String serviceEndpoint, Map<String,String> pathParams, Map<String, List<String>> queryParams)
protected String	createReturningLocationUuid(String serviceEndpoint, Map<String,String> pathParams, Map<String, List<String>> queryParams, Object body)	POST a body, then return the created resource's uuid parsed from the response Location header (for endpoints that return 201 Location: .../{uuid} rather than a body).
protected <R> R	getAs(String serviceEndpoint, Class<R> responseType)
protected <R> R	getAs(String serviceEndpoint, Map<String,String> pathParams, Map<String, List<String>> queryParams, Class<R> responseType)
protected Config	getConfigClient()
protected <T> EquinixResponse<T>	invoke(EquinixRequest<T> equinixRequest)
protected <R> List<R>	listAs(String serviceEndpoint, Map<String,String> pathParams, Map<String, List<String>> queryParams, Class<R> elementType)
protected Map<String,String>	mapOp(String serviceEndpoint, RequestType requestType, Map<String,String> pathParams, Map<String, List<String>> queryParams, Object body)
protected ClientBase.EquinixRequestBuilder	newRequest(String serviceEndpoint)	Creates a fluent request builder for the given service endpoint.
protected <R> R	postAs(String serviceEndpoint, Object body, Class<R> responseType)
protected <R> R	postForType(String serviceEndpoint, Object body, com.fasterxml.jackson.core.type.TypeReference<?> typeReference)
protected <R> R	postForType(String serviceEndpoint, Map<String,String> pathParams, Object body, com.fasterxml.jackson.core.type.TypeReference<?> typeReference)
protected <R> R	postForType(String serviceEndpoint, Map<String,String> pathParams, Map<String, List<String>> queryParams, Object body, com.fasterxml.jackson.core.type.TypeReference<?> typeReference)
protected <R> List<R>	postListAs(String serviceEndpoint, Object body, Class<R> elementType)
protected String	stringOp(String serviceEndpoint, RequestType requestType, Map<String,String> pathParams, Map<String, List<String>> queryParams, Object body)
protected void	voidOp(String serviceEndpoint, RequestType requestType, Map<String,String> pathParams, Map<String, List<String>> queryParams, Object body)	Execute a request for its side effect only - the response body is validated (throws on API error) and discarded.

Methods inherited from class Object

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

Constructor Details

StreamAssetClientImpl

public StreamAssetClientImpl(FabricConfigImpl configClient)

Method Details

wrap

protected StreamAsset wrap(StreamAssetJson json)

Description copied from class: ResourceClientBase

Wraps a JSON model into its public model type, binding this client so the returned object can refresh/delete/page itself.

Specified by:

wrap in class ResourceClientBase<StreamAsset, StreamAssetJson>

Parameters:

json - the deserialized JSON model

Returns:

the public model wrapper

get

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

Specified by:

get in interface StreamAssetClient<StreamAsset>

attach

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

Specified by:

attach in interface StreamAssetClient<StreamAsset>

detach

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

Specified by:

detach in interface StreamAssetClient<StreamAsset>

search

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

Description copied from interface: StreamAssetClient

POST /fabric/v4/streamAssets/search.

Specified by:

search in interface StreamAssetClient<StreamAsset>

Parameters:

filter - the filter, or null

sort - the sort, or null

Returns:

the first page

getDevice

public StreamAssetJson getDevice(String streamId,
 String deviceId)

Description copied from interface: StreamAssetClient

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

Specified by:

getDevice in interface StreamAssetClient<StreamAsset>

Parameters:

streamId - the stream uuid

deviceId - the Network Edge device uuid

Returns:

the device asset

updateDevice

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

Description copied from interface: StreamAssetClient

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

Specified by:

updateDevice in interface StreamAssetClient<StreamAsset>

Parameters:

streamId - the stream uuid

deviceId - the Network Edge device uuid

request - the desired interfaces

Returns:

the device asset (202)

deleteDevice

public StreamAssetJson deleteDevice(String streamId,
 String deviceId)

Description copied from interface: StreamAssetClient

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

Specified by:

deleteDevice in interface StreamAssetClient<StreamAsset>

Parameters:

streamId - the stream uuid

deviceId - the Network Edge device uuid

Returns:

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