Package org.opensearch.client.transport

Interface GenericEndpoint<RequestT,ResponseT>

All Superinterfaces:

Endpoint<RequestT,ResponseT,ResponseT>

public interface GenericEndpoint<RequestT,ResponseT>
extends Endpoint<RequestT,ResponseT,ResponseT>

An endpoint with a raw, unparsed response body. The endpoind does not distinguish between errornous and successful response and always return the raw response body.

Method Summary

Modifier and Type	Method	Description
default JsonpDeserializer<ResponseT>	errorDeserializer(int statusCode)	The error is never deserialized explicitly, represented as the instance of GenericEndpoint instead.
default boolean	isError(int statusCode)	Is this status code to be considered as an error?
ResponseT	responseDeserializer(java.lang.String uri, java.lang.String method, java.lang.String protocol, int status, java.lang.String reason, java.util.List<java.util.Map.Entry<java.lang.String,java.lang.String>> headers, java.lang.String contentType, java.io.InputStream body)	Constructs the GenericEndpoint instance

Methods inherited from interface org.opensearch.client.transport.Endpoint

exceptionConverter, hasRequestBody, headers, method, queryParameters, requestUrl

Method Detail

isError

default 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,ResponseT>

errorDeserializer

default JsonpDeserializer<ResponseT> errorDeserializer(int statusCode)

The error is never deserialized explicitly, represented as the instance of GenericEndpoint instead.

Specified by:

errorDeserializer in interface Endpoint<RequestT,ResponseT,ResponseT>

responseDeserializer

ResponseT responseDeserializer(java.lang.String uri,
                               java.lang.String method,
                               java.lang.String protocol,
                               int status,
                               java.lang.String reason,
                               java.util.List<java.util.Map.Entry<java.lang.String,java.lang.String>> headers,
                               @Nullable
                               java.lang.String contentType,
                               @Nullable
                               java.io.InputStream body)

Constructs the GenericEndpoint instance

Parameters:

uri - request URI

method - HTTP method

protocol - HTTP protocol version

status - status code

reason - reason phrase

headers - response headers

body - optional body

Returns:

the GenericEndpoint instance