Package co.elastic.clients.transport.endpoints

Class EndpointBase<RequestT,ResponseT>

java.lang.Object

co.elastic.clients.transport.endpoints.EndpointBase<RequestT,ResponseT>

All Implemented Interfaces:

Endpoint<RequestT,ResponseT,ErrorResponse>

Direct Known Subclasses:

BinaryEndpoint, BooleanEndpoint, SimpleEndpoint

public class EndpointBase<RequestT,ResponseT>
extends Object
implements Endpoint<RequestT,ResponseT,ErrorResponse>

Field Summary

Fields

Modifier and Type	Field	Description
protected final Function<RequestT,Object>	body
protected final Function<RequestT,Map<String,String>>	headers
protected final String	id
protected final Function<RequestT,String>	method
protected final Function<RequestT,Map<String,String>>	pathParameters
protected final Function<RequestT,Map<String,String>>	queryParameters
protected final Function<RequestT,String>	requestUrl

Constructor Summary

Constructors

Constructor	Description
EndpointBase(String id, Function<RequestT,String> method, Function<RequestT,String> requestUrl, Function<RequestT,Map<String,String>> pathParameters, Function<RequestT,Map<String,String>> queryParameters, Function<RequestT,Map<String,String>> headers, Function<RequestT,Object> body)

Method Summary

Modifier and Type	Method	Description
Object	body(RequestT request)	Get the body for a request.
static <T> Function<T,Map<String,String>>	emptyMap()	Returns a function that always returns an empty String to String map.
JsonpDeserializer<ErrorResponse>	errorDeserializer(int statusCode)	The entity parser for the error response body.
Map<String,String>	headers(RequestT request)	Get the HTTP headers for a request.
String	id()	The endpoint's identifier.
boolean	isError(int statusCode)	Is this status code to be considered as an error?
String	method(RequestT request)	Get the endpoint's HTTP method for a request.
static RuntimeException	noPathTemplateFound(String what)
static void	pathEncode(String src, StringBuilder dest)
Map<String,String>	pathParameters(RequestT request)	Get the path parameters for a request.
Map<String,String>	queryParameters(RequestT request)	Get the query parameters for a request.
String	requestUrl(RequestT request)	Get the URL path for a request.
static <T, U> Function<T,U>	returnSelf()	Returns a function that always returns its parameter.
<NewResponseT> SimpleEndpoint<RequestT,NewResponseT>	withResponseDeserializer(JsonpDeserializer<NewResponseT> newResponseParser)

Methods inherited from class java.lang.Object

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

Methods inherited from interface co.elastic.clients.transport.Endpoint

call, call, callAsync, callAsync, withBinaryResponse

Field Details

id

protected final String id

method

protected final Function<RequestT,String> method

requestUrl

protected final Function<RequestT,String> requestUrl

pathParameters

protected final Function<RequestT,Map<String,String>> pathParameters

queryParameters

protected final Function<RequestT,Map<String,String>> queryParameters

headers

protected final Function<RequestT,Map<String,String>> headers

body

protected final Function<RequestT,Object> body

Constructor Details

EndpointBase

public EndpointBase(String id,
 Function<RequestT,String> method,
 Function<RequestT,String> requestUrl,
 Function<RequestT,Map<String,String>> pathParameters,
 Function<RequestT,Map<String,String>> queryParameters,
 Function<RequestT,Map<String,String>> headers,
 Function<RequestT,Object> body)

Method Details

emptyMap

public static <T> Function<T,Map<String,String>> emptyMap()

Returns a function that always returns an empty String to String map. Useful to avoid creating lots of duplicate lambdas in endpoints that don't have headers or parameters.

returnSelf

public static <T,
U> Function<T,U> returnSelf()

Returns a function that always returns its parameter. It's similar to Function.identity() with the difference that the input and output generic parameters are different, making it suitable for use in a wider range of use cases.

id

public String id()

Description copied from interface: Endpoint

The endpoint's identifier.

Specified by:

id in interface Endpoint<RequestT,ResponseT,ErrorResponse>

method

public String method(RequestT request)

Description copied from interface: Endpoint

Get the endpoint's HTTP method for a request.

Specified by:

method in interface Endpoint<RequestT,ResponseT,ErrorResponse>

requestUrl

public String requestUrl(RequestT request)

Description copied from interface: Endpoint

Get the URL path for a request.

Specified by:

requestUrl in interface Endpoint<RequestT,ResponseT,ErrorResponse>

pathParameters

public Map<String,String> pathParameters(RequestT request)

Description copied from interface: Endpoint

Get the path parameters for a request.

Specified by:

pathParameters in interface Endpoint<RequestT,ResponseT,ErrorResponse>

queryParameters

public Map<String,String> queryParameters(RequestT request)

Description copied from interface: Endpoint

Get the query parameters for a request.

Specified by:

queryParameters in interface Endpoint<RequestT,ResponseT,ErrorResponse>

headers

public Map<String,String> headers(RequestT request)

Description copied from interface: Endpoint

Get the HTTP headers for a request.

Specified by:

headers in interface Endpoint<RequestT,ResponseT,ErrorResponse>

body

@Nullable
public Object body(RequestT request)

Description copied from interface: Endpoint

Get the body for a request. The caller must handle several cases depending on the interface implemented by the result:

null means the request has no body.

NdJsonpSerializable must be serialized as nd-json.

BinaryData must be serialized as is.

All other objects must be serialized as JSON using a JsonpMapper

Specified by:

body in interface Endpoint<RequestT,ResponseT,ErrorResponse>

isError

public boolean isError(int statusCode)

Description copied from interface: Endpoint

Is this status code to be considered as an error?

Specified by:

isError in interface Endpoint<RequestT,ResponseT,ErrorResponse>

errorDeserializer

public JsonpDeserializer<ErrorResponse> errorDeserializer(int statusCode)

Description copied from interface: Endpoint

The entity parser for the error response body. Can be null to indicate that there's no error body.

Specified by:

errorDeserializer in interface Endpoint<RequestT,ResponseT,ErrorResponse>

withResponseDeserializer

public <NewResponseT>
SimpleEndpoint<RequestT,NewResponseT> withResponseDeserializer(JsonpDeserializer<NewResponseT> newResponseParser)

noPathTemplateFound

public static RuntimeException noPathTemplateFound(String what)

pathEncode

public static void pathEncode(String src,
 StringBuilder dest)