com.google.api.gax.httpjson

Interface HttpRequestFormatter<MessageFormatT>

All Known Implementing Classes:

ApiMessageHttpRequestFormatter

@BetaApi
public interface HttpRequestFormatter<MessageFormatT>

Interface for classes that create parts of Http requests from a parameterized message.

Method Summary

Modifier and Type	Method and Description
Map<String,String>	getPathParams(MessageFormatT apiMessage, Set<String> paramNames) Return a map where each entry is the name of a path param mapped to the value of the param.
Map<String,List<String>>	getQueryParams(MessageFormatT apiMessage, Set<String> paramNames) Return a map where each entry is the name of a query param mapped to the values of the param.
void	writeRequestBody(MessageFormatT apiMessage, com.google.gson.Gson marshaller, Appendable writer) Write out the inner request body of the given message.

Method Detail

getQueryParams

Map<String,List<String>> getQueryParams(MessageFormatT apiMessage,
                                        Set<String> paramNames)

Return a map where each entry is the name of a query param mapped to the values of the param.

getPathParams

Map<String,String> getPathParams(MessageFormatT apiMessage,
                                 Set<String> paramNames)

Return a map where each entry is the name of a path param mapped to the value of the param.

writeRequestBody

void writeRequestBody(MessageFormatT apiMessage,
                      com.google.gson.Gson marshaller,
                      Appendable writer)

Write out the inner request body of the given message.