Class BackupClientImpl

java.lang.Object

com.eqixiac.equinix.core.client.ClientBase

com.eqixiac.equinix.core.client.ResourceClientBase<Backup, BackupJson>

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

All Implemented Interfaces:

Pageable<Backup>, PageablePost<Backup>, BackupClient<Backup>

public class BackupClientImpl
extends ResourceClientBase<Backup, BackupJson>
implements BackupClient<Backup>

Internal client for Network Edge device Backups. Plumbing/paging come from ResourceClientBase; Network Edge's non-standard contracts (create->UUIDResult->refetch, update->refetch, Boolean delete/restore, String download, secondary restore-analysis type) use the generic helpers on ClientBase.

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

Method Summary

Modifier and Type	Method	Description
RestoreFeasibilityJson	checkRestoreFeasibility(String uuid, String deviceUuid)
BackupJson	create(BackupCreatorJson backupCreatorJson)
Boolean	delete(String uuid)
String	download(String uuid)
BackupJson	getByUuid(String uuid)
Page<BackupJson>	list(String deviceUuid, RequestBuilder.Backup requestBuilder)
BackupJson	refresh(String uuid)
Boolean	restore(String uuid, String name)	restore.
BackupJson	update(String uuid, BackupUpdaterJson backupUpdaterJson)
protected Backup	wrap(BackupJson 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 BackupJson	createOne(Object creatorBody)	create(body) via the derived Create<Singular> endpoint name.
protected BackupJson	deleteOne(String serviceEndpoint, String uuid)
protected BackupJson	deleteOne(String serviceEndpoint, Map<String,String> pathParams)
protected BackupJson	deleteOneByUuid(String uuid)	delete(uuid) via the derived Delete<Singular> endpoint name.
protected BackupJson	dryRunCreate(String serviceEndpoint, Object body)
protected BackupJson	dryRunCreate(String serviceEndpoint, Object body, com.fasterxml.jackson.databind.ser.FilterProvider filters)
protected BackupJson	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 BackupJson	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 BackupJson	getOne(String serviceEndpoint, String uuid)
protected BackupJson	getOne(String serviceEndpoint, Map<String,String> pathParams)
protected BackupJson	getOneByUuid(String uuid)	get(uuid) via the derived Get<Singular> endpoint name.
protected Page<BackupJson>	listPage()	list() via the derived List<Plural> endpoint name.
protected Page<BackupJson>	listPage(String serviceEndpoint)
protected Page<BackupJson>	listPage(String serviceEndpoint, Map<String, List<String>> queryParams)
protected Page<BackupJson>	listPagePath(String serviceEndpoint, Map<String,String> pathParams)
PaginatedFilteredList<Backup>	nextPage(PaginatedPostRequest<Backup> equinixRequest)	Fetches the next page for the given POST-search request (its body's pagination has already been advanced by the paging pipeline).
PaginatedList<Backup>	nextPage(PaginatedRequest<Backup> equinixRequest)
protected BackupJson	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 BackupJson	patchOne(String serviceEndpoint, Map<String,String> pathParams, List<PatchOperation> operations)
protected BackupJson	postOne(String serviceEndpoint, Object creatorBody)
protected BackupJson	postOne(String serviceEndpoint, Object body, com.fasterxml.jackson.databind.ser.FilterProvider filters)
protected BackupJson	postOne(String serviceEndpoint, Map<String,String> pathParams, Object body)
protected Page<BackupJson>	searchPage(Object filterSortBody)	search(body) via the derived Search<Plural> endpoint name.
protected Page<BackupJson>	searchPage(String serviceEndpoint, Object filterSortBody)
protected Page<BackupJson>	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<BackupJson>	searchPageQueryPaginated(String serviceEndpoint, Map<String, List<String>> queryParams, Object filterBody)	Variant of ResourceClientBase.searchPageQueryPaginated(String, Object) carrying additional query parameters (e.g.
protected BackupJson	updateOne(String serviceEndpoint, String uuid, Object body)
protected BackupJson	updateOne(String serviceEndpoint, Map<String,String> pathParams, Object body)
protected BackupJson	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

BackupClientImpl

public BackupClientImpl(NetworkEdgeConfigImpl configClient)

Method Details

wrap

protected Backup wrap(BackupJson 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<Backup, BackupJson>

Parameters:

json - the deserialized JSON model

Returns:

the public model wrapper

list

public Page<BackupJson> list(String deviceUuid,
 RequestBuilder.Backup requestBuilder)

Specified by:

list in interface BackupClient<Backup>

getByUuid

public BackupJson getByUuid(String uuid)

Specified by:

getByUuid in interface BackupClient<Backup>

checkRestoreFeasibility

public RestoreFeasibilityJson checkRestoreFeasibility(String uuid,
 String deviceUuid)

Specified by:

checkRestoreFeasibility in interface BackupClient<Backup>

restore

public Boolean restore(String uuid,
 String name)

Description copied from interface: BackupClient

restore. Restores the backup identified by uuid (the backup uuid). The spec requires the backup name in the request body.

Specified by:

restore in interface BackupClient<Backup>

Parameters:

uuid - the unique identifier of the backup to restore.

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

download

public String download(String uuid)

Specified by:

download in interface BackupClient<Backup>

create

public BackupJson create(BackupCreatorJson backupCreatorJson)

Specified by:

create in interface BackupClient<Backup>

update

public BackupJson update(String uuid,
 BackupUpdaterJson backupUpdaterJson)

delete

public Boolean delete(String uuid)

Specified by:

delete in interface BackupClient<Backup>

refresh

public BackupJson refresh(String uuid)

Specified by:

refresh in interface BackupClient<Backup>