Package org.opensearch.client.transport.endpoints

Class SimpleEndpoint<RequestT,ResponseT>

java.lang.Object

org.opensearch.client.transport.endpoints.SimpleEndpoint<RequestT,ResponseT>

All Implemented Interfaces:

Endpoint<RequestT,ResponseT,ErrorResponse>, JsonEndpoint<RequestT,ResponseT,ErrorResponse>

Direct Known Subclasses:

BooleanEndpoint

public class SimpleEndpoint<RequestT,ResponseT>
extends java.lang.Object
implements JsonEndpoint<RequestT,ResponseT,ErrorResponse>

Constructor Summary

Constructors

Constructor

Description

SimpleEndpoint(java.util.function.Function<RequestT,java.lang.String> method, java.util.function.Function<RequestT,java.lang.String> requestUrl, java.util.function.Function<RequestT,java.util.Map<java.lang.String,java.lang.String>> queryParameters, java.util.function.Function<RequestT,java.util.Map<java.lang.String,java.lang.String>> headers, boolean hasRequestBody, JsonpDeserializer<ResponseT> responseParser)

Method Summary

Modifier and Type	Method	Description
static <T> java.util.function.Function<T,java.util.Map<java.lang.String,java.lang.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.
boolean	hasRequestBody()
java.util.Map<java.lang.String,java.lang.String>	headers(RequestT request)	Get the HTTP headers for a request.
boolean	isError(int statusCode)	Is this status code to be considered as an error?
java.lang.String	method(RequestT request)	Get the endpoint's HTTP method for a request.
static java.lang.RuntimeException	noPathTemplateFound(java.lang.String what)
static void	pathEncode(java.lang.String src, java.lang.StringBuilder dest)
java.util.Map<java.lang.String,java.lang.String>	queryParameters(RequestT request)	Get the query parameters for a request.
java.lang.String	requestUrl(RequestT request)	Get the URL path for a request.
JsonpDeserializer<ResponseT>	responseDeserializer()	The entity parser for the response body.
<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

Constructor Detail

SimpleEndpoint

public SimpleEndpoint(java.util.function.Function<RequestT,java.lang.String> method,
                      java.util.function.Function<RequestT,java.lang.String> requestUrl,
                      java.util.function.Function<RequestT,java.util.Map<java.lang.String,java.lang.String>> queryParameters,
                      java.util.function.Function<RequestT,java.util.Map<java.lang.String,java.lang.String>> headers,
                      boolean hasRequestBody,
                      JsonpDeserializer<ResponseT> responseParser)

Method Detail

emptyMap

public static <T> java.util.function.Function<T,java.util.Map<java.lang.String,java.lang.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.

method

public java.lang.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 java.lang.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>

queryParameters

public java.util.Map<java.lang.String,java.lang.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 java.util.Map<java.lang.String,java.lang.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>

hasRequestBody

public boolean hasRequestBody()

Specified by:

hasRequestBody in interface Endpoint<RequestT,ResponseT,ErrorResponse>

responseDeserializer

public JsonpDeserializer<ResponseT> responseDeserializer()

Description copied from interface: JsonEndpoint

The entity parser for the response body.

Specified by:

responseDeserializer in interface JsonEndpoint<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 java.lang.RuntimeException noPathTemplateFound(java.lang.String what)

pathEncode

public static void pathEncode(java.lang.String src,
                              java.lang.StringBuilder dest)