Class DeviceClientImpl

java.lang.Object

com.eqixiac.equinix.core.client.ClientBase

com.eqixiac.equinix.core.client.ResourceClientBase<Device, DeviceJson>

com.eqixiac.equinix.networkedge.client.internal.implementation.DeviceClientImpl

All Implemented Interfaces:

Pageable<Device>, PageablePost<Device>, DeviceClient<Device>

public class DeviceClientImpl
extends ResourceClientBase<Device, DeviceJson>
implements DeviceClient<Device>

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
DeviceClientImpl(NetworkEdgeConfigImpl configClient)

Method Summary

Modifier and Type	Method	Description
DeviceACL	addACL(String uuid, DeviceACLRequest deviceACLRequest, String accountUcmId)
DeviceJson	create(DeviceCreatorJson deviceCreatorJson, Boolean draft)
Boolean	createRMA(String uuid, DeviceRMARequest deviceRMARequest)
Boolean	delete(String uuid)
Boolean	delete(String uuid, DeviceDeleteRequest request)
DeviceACL	getACL(String uuid)
AllowedInterfaceResponse	getAllowedInterfaces(String deviceType, Map<String, List<String>> queryParams)
DeviceJson	getByUuid(String uuid)
InterfaceStats	getInterfaceStatistics(String uuid, String interfaceId, Instant startDateTime, Instant endDateTime)
Pricing	getPricing(String deviceUuid)
Page<DeviceJson>	list(RequestBuilder.Device requestBuilder)
List<DownloadableImage>	listDownloadableImages(String deviceType)
List<NetworkInterface>	listInterfaces(String uuid)
List<DeviceReboot>	listReloadHistory(String uuid)
List<DeviceUpgrade>	listUpgradeHistory(String uuid)
Boolean	ping(String uuid)
String	postLicenseFile(MetroCode metroCode, String deviceTypeCode, LicenseType licenseType, String fileContents)	POST /ne/v1/devices/licenseFiles.
String	postLicenseFile(String deviceUuid, String fileContents)	POST /ne/v1/devices/licenseFiles/{uuid}, multipart/form-data as above.
DeviceJson	refresh(String uuid)
ImageDownload	requestImageDownload(String deviceType, String version)
Boolean	restore(String backupUuid, String backupName)	restore.
Boolean	softReboot(String uuid)
DeviceJson	update(String uuid, DeviceUpdaterJson deviceUpdaterJson)
DeviceACL	updateACL(String uuid, DeviceACLRequest deviceACLRequest, String accountUcmId)
DeviceJson	updateAdditionalBandwidth(String uuid, Integer additionalBandwidth)
String	updateLicenseToken(String deviceUuid, String licenseToken)	PUT /ne/v1/devices/{uuid}/licenseTokens, answered with 202 Accepted.
protected Device	wrap(DeviceJson 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 DeviceJson	createOne(Object creatorBody)	create(body) via the derived Create<Singular> endpoint name.
protected DeviceJson	deleteOne(String serviceEndpoint, String uuid)
protected DeviceJson	deleteOne(String serviceEndpoint, Map<String,String> pathParams)
protected DeviceJson	deleteOneByUuid(String uuid)	delete(uuid) via the derived Delete<Singular> endpoint name.
protected DeviceJson	dryRunCreate(String serviceEndpoint, Object body)
protected DeviceJson	dryRunCreate(String serviceEndpoint, Object body, com.fasterxml.jackson.databind.ser.FilterProvider filters)
protected DeviceJson	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 DeviceJson	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 DeviceJson	getOne(String serviceEndpoint, String uuid)
protected DeviceJson	getOne(String serviceEndpoint, Map<String,String> pathParams)
protected DeviceJson	getOneByUuid(String uuid)	get(uuid) via the derived Get<Singular> endpoint name.
protected Page<DeviceJson>	listPage()	list() via the derived List<Plural> endpoint name.
protected Page<DeviceJson>	listPage(String serviceEndpoint)
protected Page<DeviceJson>	listPage(String serviceEndpoint, Map<String, List<String>> queryParams)
protected Page<DeviceJson>	listPagePath(String serviceEndpoint, Map<String,String> pathParams)
PaginatedFilteredList<Device>	nextPage(PaginatedPostRequest<Device> equinixRequest)	Fetches the next page for the given POST-search request (its body's pagination has already been advanced by the paging pipeline).
PaginatedList<Device>	nextPage(PaginatedRequest<Device> equinixRequest)
protected DeviceJson	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 DeviceJson	patchOne(String serviceEndpoint, Map<String,String> pathParams, List<PatchOperation> operations)
protected DeviceJson	postOne(String serviceEndpoint, Object creatorBody)
protected DeviceJson	postOne(String serviceEndpoint, Object body, com.fasterxml.jackson.databind.ser.FilterProvider filters)
protected DeviceJson	postOne(String serviceEndpoint, Map<String,String> pathParams, Object body)
protected Page<DeviceJson>	searchPage(Object filterSortBody)	search(body) via the derived Search<Plural> endpoint name.
protected Page<DeviceJson>	searchPage(String serviceEndpoint, Object filterSortBody)
protected Page<DeviceJson>	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<DeviceJson>	searchPageQueryPaginated(String serviceEndpoint, Map<String, List<String>> queryParams, Object filterBody)	Variant of ResourceClientBase.searchPageQueryPaginated(String, Object) carrying additional query parameters (e.g.
protected DeviceJson	updateOne(String serviceEndpoint, String uuid, Object body)
protected DeviceJson	updateOne(String serviceEndpoint, Map<String,String> pathParams, Object body)
protected DeviceJson	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

DeviceClientImpl

public DeviceClientImpl(NetworkEdgeConfigImpl configClient)

Method Details

wrap

protected Device wrap(DeviceJson 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<Device, DeviceJson>

Parameters:

json - the deserialized JSON model

Returns:

the public model wrapper

list

public Page<DeviceJson> list(RequestBuilder.Device requestBuilder)

Specified by:

list in interface DeviceClient<Device>

getByUuid

public DeviceJson getByUuid(String uuid)

Specified by:

getByUuid in interface DeviceClient<Device>

listInterfaces

public List<NetworkInterface> listInterfaces(String uuid)

Specified by:

listInterfaces in interface DeviceClient<Device>

getAllowedInterfaces

public AllowedInterfaceResponse getAllowedInterfaces(String deviceType,
 Map<String, List<String>> queryParams)

Specified by:

getAllowedInterfaces in interface DeviceClient<Device>

Parameters:

deviceType - the device type code.

queryParams - the configuration query parameters.

listReloadHistory

public List<DeviceReboot> listReloadHistory(String uuid)

Specified by:

listReloadHistory in interface DeviceClient<Device>

Parameters:

uuid - the device uuid.

listUpgradeHistory

public List<DeviceUpgrade> listUpgradeHistory(String uuid)

Specified by:

listUpgradeHistory in interface DeviceClient<Device>

Parameters:

uuid - the device uuid.

getInterfaceStatistics

public InterfaceStats getInterfaceStatistics(String uuid,
 String interfaceId,
 Instant startDateTime,
 Instant endDateTime)

Specified by:

getInterfaceStatistics in interface DeviceClient<Device>

Parameters:

uuid - the device uuid.

interfaceId - the interface id.

startDateTime - the start of the stats window (ISO-8601), or null.

endDateTime - the end of the stats window (ISO-8601), or null.

listDownloadableImages

public List<DownloadableImage> listDownloadableImages(String deviceType)

Specified by:

listDownloadableImages in interface DeviceClient<Device>

Parameters:

deviceType - the device type code.

requestImageDownload

public ImageDownload requestImageDownload(String deviceType,
 String version)

Specified by:

requestImageDownload in interface DeviceClient<Device>

Parameters:

deviceType - the device type code.

version - the device version.

restore

public Boolean restore(String backupUuid,
 String backupName)

Description copied from interface: DeviceClient

restore. Restores the backup identified by backupUuid. Per the spec the backup name is required in the request body.

Specified by:

restore in interface DeviceClient<Device>

Parameters:

backupUuid - the unique identifier of the backup to restore.

backupName - the name of the backup (DeviceBackupUpdateRequest.name).

updateAdditionalBandwidth

public DeviceJson updateAdditionalBandwidth(String uuid,
 Integer additionalBandwidth)

Specified by:

updateAdditionalBandwidth in interface DeviceClient<Device>

softReboot

public Boolean softReboot(String uuid)

Specified by:

softReboot in interface DeviceClient<Device>

createRMA

public Boolean createRMA(String uuid,
 DeviceRMARequest deviceRMARequest)

Specified by:

createRMA in interface DeviceClient<Device>

getACL

public DeviceACL getACL(String uuid)

Specified by:

getACL in interface DeviceClient<Device>

addACL

public DeviceACL addACL(String uuid,
 DeviceACLRequest deviceACLRequest,
 String accountUcmId)

Specified by:

addACL in interface DeviceClient<Device>

updateACL

public DeviceACL updateACL(String uuid,
 DeviceACLRequest deviceACLRequest,
 String accountUcmId)

Specified by:

updateACL in interface DeviceClient<Device>

ping

public Boolean ping(String uuid)

Specified by:

ping in interface DeviceClient<Device>

postLicenseFile

public String postLicenseFile(MetroCode metroCode,
 String deviceTypeCode,
 LicenseType licenseType,
 String fileContents)

POST /ne/v1/devices/licenseFiles. The spec accepts only multipart/form-data with a binary file part (LicenseUploadRequest); metroCode, deviceTypeCode and licenseType are required query parameters.

Specified by:

postLicenseFile in interface DeviceClient<Device>

postLicenseFile

public String postLicenseFile(String deviceUuid,
 String fileContents)

POST /ne/v1/devices/licenseFiles/{uuid}, multipart/form-data as above.

Specified by:

postLicenseFile in interface DeviceClient<Device>

updateLicenseToken

public String updateLicenseToken(String deviceUuid,
 String licenseToken)

PUT /ne/v1/devices/{uuid}/licenseTokens, answered with 202 Accepted. Returns the fileId when the service includes one, or null for an empty 202 body; the update has been accepted either way.

Specified by:

updateLicenseToken in interface DeviceClient<Device>

getPricing

public Pricing getPricing(String deviceUuid)

create

public DeviceJson create(DeviceCreatorJson deviceCreatorJson,
 Boolean draft)

Specified by:

create in interface DeviceClient<Device>

update

public DeviceJson update(String uuid,
 DeviceUpdaterJson deviceUpdaterJson)

Specified by:

update in interface DeviceClient<Device>

delete

public Boolean delete(String uuid)

Specified by:

delete in interface DeviceClient<Device>

delete

public Boolean delete(String uuid,
 DeviceDeleteRequest request)

Specified by:

delete in interface DeviceClient<Device>

refresh

public DeviceJson refresh(String uuid)

Specified by:

refresh in interface DeviceClient<Device>