Package co.elastic.clients.transport
Interface Endpoint<RequestT,ResponseT,ErrorT>
- Type Parameters:
RequestT
- the endpoint's requestResponseT
- the endpoint's response. UseVoid
when there's no response body.ErrorT
- the endpoint's error type. UseVoid
when error responses have no body.
- All Known Subinterfaces:
JsonEndpoint<RequestT,
ResponseT, ErrorT>
- All Known Implementing Classes:
BinaryEndpoint
,BooleanEndpoint
,DelegatingJsonEndpoint
,EndpointBase
,EndpointWithResponseMapperAttr
,SimpleEndpoint
,SimpleJsonEndpoint
public interface Endpoint<RequestT,ResponseT,ErrorT>
An endpoint links requests and responses to HTTP protocol encoding. It also defines the error response
when the server cannot perform the request.
Requests are serialized as JSON by default, unless they implement specific marker interfaces that indicate
otherwise and must be handled by the transport processing the request (e.g. NdJsonpSerializable
).
Response body decoding, when applicable, is defined by child interfaces like JsonEndpoint
.
-
Method Summary
Modifier and TypeMethodDescriptionerrorDeserializer
(int statusCode) The entity parser for the error response body.boolean
Get the HTTP headers for a request.id()
The endpoint's identifier.boolean
isError
(int statusCode) Is this status code to be considered as an error?Get the endpoint's HTTP method for a request.queryParameters
(RequestT request) Get the query parameters for a request.requestUrl
(RequestT request) Get the URL path for a request.
-
Method Details
-
id
String id()The endpoint's identifier. -
method
Get the endpoint's HTTP method for a request. -
requestUrl
Get the URL path for a request. -
queryParameters
Get the query parameters for a request. -
headers
Get the HTTP headers for a request. -
hasRequestBody
boolean hasRequestBody() -
isError
boolean isError(int statusCode) Is this status code to be considered as an error? -
errorDeserializer
The entity parser for the error response body. Can benull
to indicate that there's no error body.
-