com.google.api.gax.httpjson

Class ApiMessageHttpRequestFormatter

java.lang.Object

com.google.api.gax.httpjson.ApiMessageHttpRequestFormatter

All Implemented Interfaces:

HttpRequestFormatter<ApiMessage>

@BetaApi
public class ApiMessageHttpRequestFormatter
extends Object
implements HttpRequestFormatter<ApiMessage>

Utility class to parse ApiMessages into various HTTP request parts.

Constructor Summary

Constructors

Constructor and Description
ApiMessageHttpRequestFormatter()

Method Summary

Modifier and Type	Method and Description
Map<String,String>	getPathParams(ApiMessage 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(ApiMessage 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(ApiMessage apiMessage, com.google.gson.Gson marshaller, Appendable writer) Write out the inner request body of the given message.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ApiMessageHttpRequestFormatter

public ApiMessageHttpRequestFormatter()

Method Detail

getQueryParams

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

Description copied from interface: HttpRequestFormatter

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

Specified by:

getQueryParams in interface HttpRequestFormatter<ApiMessage>

getPathParams

public Map<String,String> getPathParams(ApiMessage apiMessage,
                                        Set<String> paramNames)

Description copied from interface: HttpRequestFormatter

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

Specified by:

getPathParams in interface HttpRequestFormatter<ApiMessage>

writeRequestBody

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

Description copied from interface: HttpRequestFormatter

Write out the inner request body of the given message.

Specified by:

writeRequestBody in interface HttpRequestFormatter<ApiMessage>