Package com.google.api.gax.httpjson

Class ProtoMessageRequestFormatter<RequestT extends com.google.protobuf.Message>

java.lang.Object

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

All Implemented Interfaces:

HttpRequestFormatter<RequestT>

public class ProtoMessageRequestFormatter<RequestT extends com.google.protobuf.Message>
extends java.lang.Object
implements HttpRequestFormatter<RequestT>

Creates parts of a HTTP request from a protobuf message.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ProtoMessageRequestFormatter.Builder<RequestT extends com.google.protobuf.Message>

Method Summary

Modifier and Type	Method	Description
java.util.List<com.google.api.pathtemplate.PathTemplate>	getAdditionalPathTemplates()	Additional (alternative) path templates for endpoint URL path.
java.lang.String	getPath(RequestT apiMessage)
com.google.api.pathtemplate.PathTemplate	getPathTemplate()	Path template for endpoint URL path.
java.util.Map<java.lang.String,java.util.List<java.lang.String>>	getQueryParamNames(RequestT apiMessage)	Return a map where each entry is the name of a query param mapped to the values of the param.
java.lang.String	getRequestBody(RequestT apiMessage)	Return the serialized inner request body of the given message.
static <RequestT extends com.google.protobuf.Message> ProtoMessageRequestFormatter.Builder<RequestT>	newBuilder()
ProtoMessageRequestFormatter.Builder<RequestT>	toBuilder()

Methods inherited from class java.lang.Object

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

Method Detail

newBuilder

public static <RequestT extends com.google.protobuf.Message> ProtoMessageRequestFormatter.Builder<RequestT> newBuilder()

toBuilder

public ProtoMessageRequestFormatter.Builder<RequestT> toBuilder()

getQueryParamNames

public java.util.Map<java.lang.String,java.util.List<java.lang.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 com.google.protobuf.Message>

getRequestBody

public java.lang.String getRequestBody(RequestT apiMessage)

Description copied from interface: HttpRequestFormatter

Return the serialized inner request body of the given message.

Specified by:

getRequestBody in interface HttpRequestFormatter<RequestT extends com.google.protobuf.Message>

getPath

public java.lang.String getPath(RequestT apiMessage)

Specified by:

getPath in interface HttpRequestFormatter<RequestT extends com.google.protobuf.Message>

getAdditionalPathTemplates

@BetaApi
public java.util.List<com.google.api.pathtemplate.PathTemplate> getAdditionalPathTemplates()

Description copied from interface: HttpRequestFormatter

Additional (alternative) path templates for endpoint URL path.

Specified by:

getAdditionalPathTemplates in interface HttpRequestFormatter<RequestT extends com.google.protobuf.Message>

getPathTemplate

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

Description copied from interface: HttpRequestFormatter

Path template for endpoint URL path.

Specified by:

getPathTemplate in interface HttpRequestFormatter<RequestT extends com.google.protobuf.Message>