Class ProtoRestSerializer<RequestT> (2.39.0)

public class ProtoRestSerializer<RequestT>

This class serializes/deserializes protobuf Message for REST interactions. It serializes requests protobuf messages into REST messages, splitting the message into the JSON request body, URL path parameters, and query parameters. It deserializes JSON responses into response protobuf message.

Inheritance

Object > ProtoRestSerializer<RequestT>

Inherited Members

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.toString()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Type Parameter
Name	Description
`RequestT`

Static Methods

<RequestT>create()

public static ProtoRestSerializer<RequestT> <RequestT>create()

Creates a new instance of ProtoRestSerializer.

Returns
Type	Description
`ProtoRestSerializer<RequestT>`

Methods

putPathParam(Map<String,String> fields, String fieldName, Object fieldValue)

public void putPathParam(Map<String,String> fields, String fieldName, Object fieldValue)

Puts a message field in fields map which will be used to populate URL path of a request.

Parameters
Name	Description
`fields`	`Map<String,String>` a map with serialized fields
`fieldName`	`String` a field name
`fieldValue`	`Object` a field value

putQueryParam(Map<String,List<String>> fields, String fieldName, Object fieldValue)

public void putQueryParam(Map<String,List<String>> fields, String fieldName, Object fieldValue)

Puts a message field in fields map which will be used to populate query parameters of a request.

Parameters
Name	Description
`fields`	`Map<String,List<String>>` a map with serialized fields
`fieldName`	`String` a field name
`fieldValue`	`Object` a field value

toBody(String fieldName, RequestT fieldValue)

public String toBody(String fieldName, RequestT fieldValue)

Serializes a message to a request body in a form of JSON-encoded string.

Parameters
Name	Description
`fieldName`	`String` a name of a request message field this message belongs to
`fieldValue`	`RequestT` a field value to serialize

Returns
Type	Description
`String`

toBody(String fieldName, RequestT fieldValue, boolean numericEnum)

public String toBody(String fieldName, RequestT fieldValue, boolean numericEnum)