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

All Implemented Interfaces:: Pageable<RouteAggregationAttachment>, PageablePost<RouteAggregationAttachment>, RouteAggregationAttachmentClient<RouteAggregationAttachment>

public class RouteAggregationAttachmentClientImpl extends ResourceClientBase<RouteAggregationAttachment, RouteAggregationAttachmentJson> implements RouteAggregationAttachmentClient<RouteAggregationAttachment>

Internal client for Fabric Route Aggregation attachments. The connection-scoped get / attach / detach operations live under the Connections resource parent, while the cloud-router attachment search lives under the CloudRouters parent, so an instance is constructed per parent (the same approach as RouteTableEntryClientImpl). The JSON model implements the public interface directly, so wrap(RouteAggregationAttachmentJson) is the identity.

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

RouteAggregationAttachmentClientImpl(FabricConfigImpl configClient, String requestParent)
Method Summary

Modifier and Type

Method

Description

RouteAggregationAttachmentJson

attachConnectionRouteAggregation(String connectionId, String routeAggregationId)

boolean

detachConnectionRouteAggregation(String connectionId, String routeAggregationId)

RouteAggregationAttachmentJson

getConnectionRouteAggregation(String connectionId, String routeAggregationId)

List<RouteAggregationAttachment>

getConnectionRouteAggregations(String connectionId)

Page<RouteAggregationAttachmentJson>

searchCloudRouterAttachments(String routerId, FilterPropertyList filter, SortPropertyList sort)

protected RouteAggregationAttachment

wrap(RouteAggregationAttachmentJson 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 RouteAggregationAttachmentJson

createOne(Object creatorBody)

create(body) via the derived Create<Singular> endpoint name.

protected RouteAggregationAttachmentJson

deleteOne(String serviceEndpoint, String uuid)

protected RouteAggregationAttachmentJson

deleteOne(String serviceEndpoint, Map<String,String> pathParams)

protected RouteAggregationAttachmentJson

deleteOneByUuid(String uuid)

delete(uuid) via the derived Delete<Singular> endpoint name.

protected RouteAggregationAttachmentJson

dryRunCreate(String serviceEndpoint, Object body)

protected RouteAggregationAttachmentJson

dryRunCreate(String serviceEndpoint, Object body, com.fasterxml.jackson.databind.ser.FilterProvider filters)

protected RouteAggregationAttachmentJson

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 RouteAggregationAttachmentJson

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 RouteAggregationAttachmentJson

getOne(String serviceEndpoint, String uuid)

protected RouteAggregationAttachmentJson

getOne(String serviceEndpoint, Map<String,String> pathParams)

protected RouteAggregationAttachmentJson

getOneByUuid(String uuid)

get(uuid) via the derived Get<Singular> endpoint name.

protected Page<RouteAggregationAttachmentJson>

listPage()

list() via the derived List<Plural> endpoint name.

protected Page<RouteAggregationAttachmentJson>

listPage(String serviceEndpoint)

protected Page<RouteAggregationAttachmentJson>

listPage(String serviceEndpoint, Map<String, List<String>> queryParams)

protected Page<RouteAggregationAttachmentJson>

listPagePath(String serviceEndpoint, Map<String,String> pathParams)

PaginatedFilteredList<RouteAggregationAttachment>

nextPage(PaginatedPostRequest<RouteAggregationAttachment> equinixRequest)

Fetches the next page for the given POST-search request (its body's pagination has already been advanced by the paging pipeline).

PaginatedList<RouteAggregationAttachment>

nextPage(PaginatedRequest<RouteAggregationAttachment> equinixRequest)

protected RouteAggregationAttachmentJson

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 RouteAggregationAttachmentJson

patchOne(String serviceEndpoint, Map<String,String> pathParams, List<PatchOperation> operations)

protected RouteAggregationAttachmentJson

postOne(String serviceEndpoint, Object creatorBody)

protected RouteAggregationAttachmentJson

postOne(String serviceEndpoint, Object body, com.fasterxml.jackson.databind.ser.FilterProvider filters)

protected RouteAggregationAttachmentJson

postOne(String serviceEndpoint, Map<String,String> pathParams, Object body)

protected Page<RouteAggregationAttachmentJson>

searchPage(Object filterSortBody)

search(body) via the derived Search<Plural> endpoint name.

protected Page<RouteAggregationAttachmentJson>

searchPage(String serviceEndpoint, Object filterSortBody)

protected Page<RouteAggregationAttachmentJson>

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<RouteAggregationAttachmentJson>

searchPageQueryPaginated(String serviceEndpoint, Map<String, List<String>> queryParams, Object filterBody)

Variant of ResourceClientBase.searchPageQueryPaginated(String, Object) carrying additional query parameters (e.g.

protected RouteAggregationAttachmentJson

updateOne(String serviceEndpoint, String uuid, Object body)

protected RouteAggregationAttachmentJson

updateOne(String serviceEndpoint, Map<String,String> pathParams, Object body)

protected RouteAggregationAttachmentJson

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
- RouteAggregationAttachmentClientImpl
  
  public RouteAggregationAttachmentClientImpl(FabricConfigImpl configClient, String requestParent)
Method Details
- wrap
  
  protected RouteAggregationAttachment wrap(RouteAggregationAttachmentJson 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<RouteAggregationAttachment, RouteAggregationAttachmentJson>
  
  Parameters:
  
  json - the deserialized JSON model
  
  Returns:
  
  the public model wrapper
- getConnectionRouteAggregations
  
  public List<RouteAggregationAttachment> getConnectionRouteAggregations(String connectionId)
  
  Specified by:
  
  getConnectionRouteAggregations in interface RouteAggregationAttachmentClient<RouteAggregationAttachment>
- getConnectionRouteAggregation
  
  public RouteAggregationAttachmentJson getConnectionRouteAggregation(String connectionId, String routeAggregationId)
  
  Specified by:
  
  getConnectionRouteAggregation in interface RouteAggregationAttachmentClient<RouteAggregationAttachment>
- attachConnectionRouteAggregation
  
  public RouteAggregationAttachmentJson attachConnectionRouteAggregation(String connectionId, String routeAggregationId)
  
  Specified by:
  
  attachConnectionRouteAggregation in interface RouteAggregationAttachmentClient<RouteAggregationAttachment>
- detachConnectionRouteAggregation
  
  public boolean detachConnectionRouteAggregation(String connectionId, String routeAggregationId)
  
  Specified by:
  
  detachConnectionRouteAggregation in interface RouteAggregationAttachmentClient<RouteAggregationAttachment>
- searchCloudRouterAttachments
  
  public Page<RouteAggregationAttachmentJson> searchCloudRouterAttachments(String routerId, FilterPropertyList filter, SortPropertyList sort)
  
  Specified by:
  
  searchCloudRouterAttachments in interface RouteAggregationAttachmentClient<RouteAggregationAttachment>

Class RouteAggregationAttachmentClientImpl

Nested Class Summary

Nested classes/interfaces inherited from class ClientBase

Constructor Summary

Method Summary

Methods inherited from class ResourceClientBase

Methods inherited from class ClientBase

Methods inherited from class Object

Constructor Details

RouteAggregationAttachmentClientImpl

Method Details

wrap

getConnectionRouteAggregations

getConnectionRouteAggregation

attachConnectionRouteAggregation

detachConnectionRouteAggregation

searchCloudRouterAttachments