Annotation Interface Request

@Documented
@Retention(SOURCE)
@Target(METHOD)
public @interface Request

Annotates an RPC endpoint. This annotation provides namespace for annotations for dialogue client generation.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static @interface	Request.Body
static @interface	Request.Header
static @interface	Request.HeaderMap
static @interface	Request.PathParam
static @interface	Request.QueryMap	Similar to the Feign QueryMap serialization type.
static @interface	Request.QueryParam

Required Element Summary

Required Elements

Modifier and Type	Required Element	Description
com.palantir.dialogue.HttpMethod	method
String	path	Request path.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
Class<? extends DeserializerFactory>	accept	Response body Deserializer.
Class<? extends ErrorDecoder>	errorDecoder	Error handling strategy.

Element Details

method

com.palantir.dialogue.HttpMethod method

path

String path

Request path. Follows conjure format. Path parameter names must correspond to parameters on the annotated method.

See Also:

• Path string

accept

Class<? extends DeserializerFactory> accept

Response body Deserializer. By default this deserializer is only used for successful (i.e. 200 <= response.code() < 300) responses.

Returns:

class that implements a zero-arg constructor to be used to deserialize the response

Default:

com.palantir.dialogue.annotations.Json.class

errorDecoder

Class<? extends ErrorDecoder> errorDecoder

Error handling strategy.

Returns:

class that implements a zero-arg constructor to be used to deserialize an error response

Default:

com.palantir.dialogue.annotations.ConjureErrorDecoder.class