com.google.api.gax.httpjson

Class ApiMessageHttpRequestFormatter<RequestT extends ApiMessage>

java.lang.Object

com.google.api.gax.httpjson.ApiMessageHttpRequestFormatter<RequestT>

All Implemented Interfaces:

HttpRequestFormatter<RequestT>

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

Utility class to parse ApiMessages into various HTTP request parts.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ApiMessageHttpRequestFormatter.Builder<RequestT extends ApiMessage>

Constructor Summary

Constructors

Constructor and Description
ApiMessageHttpRequestFormatter()

Method Summary

Modifier and Type	Method and Description
String	getPath(RequestT apiMessage)
abstract com.google.api.pathtemplate.PathTemplate	getPathTemplate() Path template for endpoint URL path.
abstract Set<String>	getQueryParamNames()
Map<String,List<String>>	getQueryParamNames(RequestT apiMessage) Return a map where each entry is the name of a query param mapped to the values of the param.
String	getRequestBody(ApiMessage apiMessage) Return the serialized inner request body of the given message.
abstract com.google.api.resourcenames.ResourceNameFactory	getResourceNameFactory() A ResourceNameFactory that can parse the resource name String into a ResourceName object.
abstract String	getResourceNameField() The name of the field in the RequestT that contains the resource name path.
static <RequestT extends ApiMessage> ApiMessageHttpRequestFormatter.Builder<RequestT>	newBuilder()

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

getResourceNameField

public abstract String getResourceNameField()

The name of the field in the RequestT that contains the resource name path.

getResourceNameFactory

public abstract com.google.api.resourcenames.ResourceNameFactory getResourceNameFactory()

A ResourceNameFactory that can parse the resource name String into a ResourceName object.

getQueryParamNames

public abstract Set<String> getQueryParamNames()

getPathTemplate

public abstract com.google.api.pathtemplate.PathTemplate getPathTemplate()

Path template for endpoint URL path.

Specified by:

getPathTemplate in interface HttpRequestFormatter<RequestT extends ApiMessage>

newBuilder

public static <RequestT extends ApiMessage> ApiMessageHttpRequestFormatter.Builder<RequestT> newBuilder()

getQueryParamNames

public Map<String,List<String>> getQueryParamNames(RequestT apiMessage)

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:

getQueryParamNames in interface HttpRequestFormatter<RequestT extends ApiMessage>

getRequestBody

public String getRequestBody(ApiMessage apiMessage)

Description copied from interface: HttpRequestFormatter

Return the serialized inner request body of the given message.

Specified by:

getRequestBody in interface HttpRequestFormatter<RequestT extends ApiMessage>

getPath

public String getPath(RequestT apiMessage)

Specified by:

getPath in interface HttpRequestFormatter<RequestT extends ApiMessage>