Class ServiceProfileClientImpl

java.lang.Object

com.eqixiac.equinix.core.client.ClientBase

com.eqixiac.equinix.core.client.ResourceClientBase<ServiceProfile, ServiceProfileJson>

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

All Implemented Interfaces:

Pageable<ServiceProfile>, PageablePost<ServiceProfile>, ServiceProfileClient<ServiceProfile>

public class ServiceProfileClientImpl
extends ResourceClientBase<ServiceProfile, ServiceProfileJson>
implements ServiceProfileClient<ServiceProfile>

Internal client for Fabric Service Profiles. Standard request/response plumbing and paging are provided by ResourceClientBase; this class supplies only the JSON class, the wrapper factory, and the per-operation endpoint names.

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
ServiceProfileClientImpl(FabricConfigImpl configClient)

Method Summary

Modifier and Type	Method	Description
ServiceProfileJson	create(ServiceProfileCreatorJson serviceProfileCreatorJson)
ServiceProfileAction	createAction(String uuid, String type, String description)
EnvironmentActionResponse	createEnvironmentAction(String uuid, String environmentId, EnvironmentActionRequest request)	POST {uuid}/environments/{environmentId}/actions.
ServiceProfileJson	delete(String uuid)
ServiceProfileJson	getByUuid(String uuid)
Page<ProviderEnvironment>	getEnvironments(String uuid)	First page of GET {uuid}/environments.
List<ServiceMetro>	getMetros(String uuid)
Page<ServiceProfileJson>	list()
ServiceProfileJson	put(String uuid, ServiceProfileCreatorJson serviceProfileCreatorJson)	PUT /fabric/v4/serviceProfiles/{uuid}.
ServiceProfileJson	put(String uuid, ServiceProfileCreatorJson serviceProfileCreatorJson, String ifMatch)	PUT /fabric/v4/serviceProfiles/{uuid} with a caller-supplied If-Match value (an ETag from an earlier read).
ServiceProfileJson	refresh(String uuid)
Page<ServiceProfileJson>	search(FilterPropertyList filter, SortPropertyList sort)
ServiceProfileJson	update(String uuid, List<PatchOperation> operations)
protected ServiceProfile	wrap(ServiceProfileJson 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 ServiceProfileJson	createOne(Object creatorBody)	create(body) via the derived Create<Singular> endpoint name.
protected ServiceProfileJson	deleteOne(String serviceEndpoint, String uuid)
protected ServiceProfileJson	deleteOne(String serviceEndpoint, Map<String,String> pathParams)
protected ServiceProfileJson	deleteOneByUuid(String uuid)	delete(uuid) via the derived Delete<Singular> endpoint name.
protected ServiceProfileJson	dryRunCreate(String serviceEndpoint, Object body)
protected ServiceProfileJson	dryRunCreate(String serviceEndpoint, Object body, com.fasterxml.jackson.databind.ser.FilterProvider filters)
protected ServiceProfileJson	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 ServiceProfileJson	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 ServiceProfileJson	getOne(String serviceEndpoint, String uuid)
protected ServiceProfileJson	getOne(String serviceEndpoint, Map<String,String> pathParams)
protected ServiceProfileJson	getOneByUuid(String uuid)	get(uuid) via the derived Get<Singular> endpoint name.
protected Page<ServiceProfileJson>	listPage()	list() via the derived List<Plural> endpoint name.
protected Page<ServiceProfileJson>	listPage(String serviceEndpoint)
protected Page<ServiceProfileJson>	listPage(String serviceEndpoint, Map<String, List<String>> queryParams)
protected Page<ServiceProfileJson>	listPagePath(String serviceEndpoint, Map<String,String> pathParams)
PaginatedFilteredList<ServiceProfile>	nextPage(PaginatedPostRequest<ServiceProfile> equinixRequest)	Fetches the next page for the given POST-search request (its body's pagination has already been advanced by the paging pipeline).
PaginatedList<ServiceProfile>	nextPage(PaginatedRequest<ServiceProfile> equinixRequest)
protected ServiceProfileJson	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 ServiceProfileJson	patchOne(String serviceEndpoint, Map<String,String> pathParams, List<PatchOperation> operations)
protected ServiceProfileJson	postOne(String serviceEndpoint, Object creatorBody)
protected ServiceProfileJson	postOne(String serviceEndpoint, Object body, com.fasterxml.jackson.databind.ser.FilterProvider filters)
protected ServiceProfileJson	postOne(String serviceEndpoint, Map<String,String> pathParams, Object body)
protected Page<ServiceProfileJson>	searchPage(Object filterSortBody)	search(body) via the derived Search<Plural> endpoint name.
protected Page<ServiceProfileJson>	searchPage(String serviceEndpoint, Object filterSortBody)
protected Page<ServiceProfileJson>	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<ServiceProfileJson>	searchPageQueryPaginated(String serviceEndpoint, Map<String, List<String>> queryParams, Object filterBody)	Variant of ResourceClientBase.searchPageQueryPaginated(String, Object) carrying additional query parameters (e.g.
protected ServiceProfileJson	updateOne(String serviceEndpoint, String uuid, Object body)
protected ServiceProfileJson	updateOne(String serviceEndpoint, Map<String,String> pathParams, Object body)
protected ServiceProfileJson	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

ServiceProfileClientImpl

public ServiceProfileClientImpl(FabricConfigImpl configClient)

Method Details

wrap

protected ServiceProfile wrap(ServiceProfileJson 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<ServiceProfile, ServiceProfileJson>

Parameters:

json - the deserialized JSON model

Returns:

the public model wrapper

list

public Page<ServiceProfileJson> list()

Specified by:

list in interface ServiceProfileClient<ServiceProfile>

search

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

Specified by:

search in interface ServiceProfileClient<ServiceProfile>

getByUuid

public ServiceProfileJson getByUuid(String uuid)

Specified by:

getByUuid in interface ServiceProfileClient<ServiceProfile>

create

public ServiceProfileJson create(ServiceProfileCreatorJson serviceProfileCreatorJson)

Specified by:

create in interface ServiceProfileClient<ServiceProfile>

update

public ServiceProfileJson update(String uuid,
 List<PatchOperation> operations)

Specified by:

update in interface ServiceProfileClient<ServiceProfile>

put

public ServiceProfileJson put(String uuid,
 ServiceProfileCreatorJson serviceProfileCreatorJson)

PUT /fabric/v4/serviceProfiles/{uuid}. The spec marks the If-Match header required; the value is the ETag the service returns on GET /serviceProfiles/{uuid}. This overload reads the current ETag first, so the replace is conditional on the profile not having changed between the read and the write.

Specified by:

put in interface ServiceProfileClient<ServiceProfile>

put

public ServiceProfileJson put(String uuid,
 ServiceProfileCreatorJson serviceProfileCreatorJson,
 String ifMatch)

PUT /fabric/v4/serviceProfiles/{uuid} with a caller-supplied If-Match value (an ETag from an earlier read). A null value sends no header.

delete

public ServiceProfileJson delete(String uuid)

Specified by:

delete in interface ServiceProfileClient<ServiceProfile>

createAction

public ServiceProfileAction createAction(String uuid,
 String type,
 String description)

Specified by:

createAction in interface ServiceProfileClient<ServiceProfile>

getMetros

public List<ServiceMetro> getMetros(String uuid)

Specified by:

getMetros in interface ServiceProfileClient<ServiceProfile>

getEnvironments

public Page<ProviderEnvironment> getEnvironments(String uuid)

Description copied from interface: ServiceProfileClient

First page of GET {uuid}/environments. The page's associated request carries an identity page-item mapper so later pages can be fetched through this client's inherited nextPage(...). Beta catalog operation.

Specified by:

getEnvironments in interface ServiceProfileClient<ServiceProfile>

createEnvironmentAction

public EnvironmentActionResponse createEnvironmentAction(String uuid,
 String environmentId,
 EnvironmentActionRequest request)

Description copied from interface: ServiceProfileClient

POST {uuid}/environments/{environmentId}/actions. Beta catalog operation.

Specified by:

createEnvironmentAction in interface ServiceProfileClient<ServiceProfile>

refresh

public ServiceProfileJson refresh(String uuid)

Specified by:

refresh in interface ServiceProfileClient<ServiceProfile>