Package api.equinix.javasdk.core.client

Class ClientBase

java.lang.Object

api.equinix.javasdk.core.client.ClientBase

Direct Known Subclasses:

AgreementClientImpl, CoreClientImpl, PageableBase, PricingClientImpl

public class ClientBase
extends Object

ClientBase class.

Version:

$Id: $Id

Author:

ianjones

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ClientBase(Config configClient, String functionalArea, String requestParent)	Constructor for ClientBase.

Method Summary

Modifier and Type	Method	Description
protected <T> EquinixRequest<T>	buildRequest(String serviceEndpoint, RequestType requestType)
protected <T> EquinixRequest<T>	buildRequest(String serviceEndpoint, RequestType requestType, com.fasterxml.jackson.core.type.TypeReference<?> typeRef)
protected <T> EquinixRequest<T>	buildRequest(String serviceEndpoint, RequestType requestType, Map<String,String> pathParams, Map<String,List<String>> queryParams)
protected <T> EquinixRequest<T>	buildRequest(String serviceEndpoint, RequestType requestType, Map<String,String> pathParams, Map<String,List<String>> queryParams, com.fasterxml.jackson.core.type.TypeReference<?> typeRef)
protected <T> EquinixRequest<T>	buildRequestWithPathParams(String serviceEndpoint, RequestType requestType, Map<String,String> pathParams)
protected <T> EquinixRequest<T>	buildRequestWithPathParams(String serviceEndpoint, RequestType requestType, Map<String,String> pathParams, com.fasterxml.jackson.core.type.TypeReference<?> typeRef)
protected <T> EquinixRequest<T>	buildRequestWithQueryParams(String serviceEndpoint, RequestType requestType, Map<String,List<String>> queryParams)
protected <T> EquinixRequest<T>	buildRequestWithQueryParams(String serviceEndpoint, RequestType requestType, Map<String,List<String>> queryParams, com.fasterxml.jackson.core.type.TypeReference<?> typeRef)
protected Config	getConfigClient()	Getter for the field configClient.
protected <T> EquinixResponse<T>	invoke(EquinixRequest<T> equinixRequest)	invoke.
protected ClientBase.EquinixRequestBuilder	newRequest(String serviceEndpoint)	Creates a fluent request builder for the given service endpoint.

Methods inherited from class java.lang.Object

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

Constructor Details

ClientBase

protected ClientBase(Config configClient,
 String functionalArea,
 String requestParent)

Constructor for ClientBase.

Parameters:

configClient - a Config object.

functionalArea - a String object.

requestParent - a String object.

Method Details

getConfigClient

protected Config getConfigClient()

Getter for the field configClient.

Returns:

a Config object.

invoke

protected <T> EquinixResponse<T> invoke(EquinixRequest<T> equinixRequest)

invoke.

Type Parameters:

T - a T object.

Parameters:

equinixRequest - a EquinixRequest object.

Returns:

a EquinixResponse object.

newRequest

protected ClientBase.EquinixRequestBuilder newRequest(String serviceEndpoint)

Creates a fluent request builder for the given service endpoint.

 EquinixRequest<Connection> request = this.newRequest("GetConnection")
     .withType(RequestType.SINGLE)
     .withPathParams(Map.of("uuid", uuid))
     .withTypeRef(ConnectionJson.getSingleTypeRef())
     .build();
 

Parameters:

serviceEndpoint - the service endpoint name from the apiParams JSON

Returns:

a new ClientBase.EquinixRequestBuilder

buildRequestWithPathParams

protected <T> EquinixRequest<T> buildRequestWithPathParams(String serviceEndpoint,
 RequestType requestType,
 Map<String,String> pathParams)

buildRequestWithQueryParams

protected <T> EquinixRequest<T> buildRequestWithQueryParams(String serviceEndpoint,
 RequestType requestType,
 Map<String,List<String>> queryParams)

buildRequest

protected <T> EquinixRequest<T> buildRequest(String serviceEndpoint,
 RequestType requestType,
 Map<String,String> pathParams,
 Map<String,List<String>> queryParams)

buildRequest

protected <T> EquinixRequest<T> buildRequest(String serviceEndpoint,
 RequestType requestType,
 com.fasterxml.jackson.core.type.TypeReference<?> typeRef)

buildRequest

protected <T> EquinixRequest<T> buildRequest(String serviceEndpoint,
 RequestType requestType)

buildRequestWithPathParams

protected <T> EquinixRequest<T> buildRequestWithPathParams(String serviceEndpoint,
 RequestType requestType,
 Map<String,String> pathParams,
 com.fasterxml.jackson.core.type.TypeReference<?> typeRef)

buildRequestWithQueryParams

protected <T> EquinixRequest<T> buildRequestWithQueryParams(String serviceEndpoint,
 RequestType requestType,
 Map<String,List<String>> queryParams,
 com.fasterxml.jackson.core.type.TypeReference<?> typeRef)

buildRequest

protected <T> EquinixRequest<T> buildRequest(String serviceEndpoint,
 RequestType requestType,
 Map<String,String> pathParams,
 Map<String,List<String>> queryParams,
 com.fasterxml.jackson.core.type.TypeReference<?> typeRef)