Interface BodySerDe

public interface BodySerDe

Request and response Deserialization and Serialization functionality used by generated code.

Method Summary

Modifier and Type	Method	Description
<T> Deserializer<T>	deserializer(ExceptionDeserializerArgs<T> exceptionDeserializerArgs)	Creates a Deserializer for the base type T specified in the ExceptionDeserializerArgs.
<T> Deserializer<T>	deserializer(TypeMarker<T> type)	Creates a Deserializer for the requested type.
Deserializer<Void>	emptyBodyDeserializer()	Returns a Deserializer that fails if a non-empty reponse body is presented and returns null otherwise.
Deserializer<Void>	emptyBodyDeserializer(ExceptionDeserializerArgs<Void> exceptionDeserializerArgs)	Similar to emptyBodyDeserializer() but allows for specifying error type to exception mapping.
default Optional<com.palantir.conjure.java.api.errors.ConjureErrorParameterFormat>	errorParameterFormat()	Specifies the expected error parameter format for deserialization.
Deserializer<InputStream>	inputStreamDeserializer()	Returns a Deserializer that reads an InputStream from the Response body.
Deserializer<InputStream>	inputStreamDeserializer(ExceptionDeserializerArgs<InputStream> exceptionDeserializerArgs)	Creates a Deserializer for input streams and with error types specified in the ExceptionDeserializerArgs.
Deserializer<Optional<InputStream>>	optionalInputStreamDeserializer()	Same as inputStreamDeserializer() with support for 204 responses.
Deserializer<Optional<InputStream>>	optionalInputStreamDeserializer(ExceptionDeserializerArgs<Optional<InputStream>> exceptionDeserializerArgs)	Same as inputStreamDeserializer(ExceptionDeserializerArgs) with support for 204 responses.
RequestBody	serialize(BinaryRequestBody value)	Serializes a BinaryRequestBody to
<T> Serializer<T>	serializer(TypeMarker<T> type)	Creates a Serializer for the requested type.

Method Details

serializer

<T> Serializer<T> serializer(TypeMarker<T> type)

Creates a Serializer for the requested type. Serializer instances should be reused.

deserializer

<T> Deserializer<T> deserializer(TypeMarker<T> type)

Creates a Deserializer for the requested type. Deserializer instances should be reused.

deserializer

<T> Deserializer<T> deserializer(ExceptionDeserializerArgs<T> exceptionDeserializerArgs)

Creates a Deserializer for the base type T specified in the ExceptionDeserializerArgs.

Deserializer instances should be reused.

emptyBodyDeserializer

Deserializer<Void> emptyBodyDeserializer()

Returns a Deserializer that fails if a non-empty reponse body is presented and returns null otherwise.

emptyBodyDeserializer

Deserializer<Void> emptyBodyDeserializer(ExceptionDeserializerArgs<Void> exceptionDeserializerArgs)

Similar to emptyBodyDeserializer() but allows for specifying error type to exception mapping.

inputStreamDeserializer

Deserializer<InputStream> inputStreamDeserializer()

Returns a Deserializer that reads an InputStream from the Response body.

This method is named

inputStreamDeserializer

not

binaryDeserializer

to support future streaming binary bindings without conflicting method signatures.

inputStreamDeserializer

Deserializer<InputStream> inputStreamDeserializer(ExceptionDeserializerArgs<InputStream> exceptionDeserializerArgs)

Creates a Deserializer for input streams and with error types specified in the ExceptionDeserializerArgs.

optionalInputStreamDeserializer

Deserializer<Optional<InputStream>> optionalInputStreamDeserializer()

Same as inputStreamDeserializer() with support for 204 responses.

optionalInputStreamDeserializer

Deserializer<Optional<InputStream>> optionalInputStreamDeserializer(ExceptionDeserializerArgs<Optional<InputStream>> exceptionDeserializerArgs)

Same as inputStreamDeserializer(ExceptionDeserializerArgs) with support for 204 responses.

serialize

RequestBody serialize(BinaryRequestBody value)

Serializes a BinaryRequestBody to

application/octet-stream

.

errorParameterFormat

default Optional<com.palantir.conjure.java.api.errors.ConjureErrorParameterFormat> errorParameterFormat()

Specifies the expected error parameter format for deserialization. This field is used in code generation, where client interfaces can specify a header sent to servers requesting an error be serialized in the selected format. Clients should not assume that servers will always respect this header, and should be able to handle errors that are serialized in any format the server provides.