Class ApiMessageHttpRequestFormatter<RequestT> (2.8.1)

public abstract class ApiMessageHttpRequestFormatter<RequestT> implements HttpRequestFormatter<RequestT>

Utility class to parse ApiMessages into various HTTP request parts.

Inheritance

java.lang.Object > ApiMessageHttpRequestFormatter<RequestT>

Implements

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

Type Parameter

NameDescription
RequestT

Constructors

ApiMessageHttpRequestFormatter()

public ApiMessageHttpRequestFormatter()

Methods

<RequestT>newBuilder()

public static ApiMessageHttpRequestFormatter.Builder<RequestT> <RequestT>newBuilder()
Returns
TypeDescription
Builder<RequestT>

getPath(RequestT apiMessage)

public String getPath(RequestT apiMessage)
Parameter
NameDescription
apiMessageRequestT
Returns
TypeDescription
String

getPathTemplate()

public abstract PathTemplate getPathTemplate()

Path template for endpoint URL path.

Returns
TypeDescription
com.google.api.pathtemplate.PathTemplate

getQueryParamNames()

public abstract Set<String> getQueryParamNames()
Returns
TypeDescription
Set<String>

getQueryParamNames(RequestT apiMessage)

public Map<String,List<String>> getQueryParamNames(RequestT apiMessage)
Parameter
NameDescription
apiMessageRequestT
Returns
TypeDescription
Map<String,List<String>>

getRequestBody(ApiMessage apiMessage)

public String getRequestBody(ApiMessage apiMessage)
Parameter
NameDescription
apiMessageApiMessage
Returns
TypeDescription
String

getResourceNameFactory()

public abstract ResourceNameFactory getResourceNameFactory()

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

Returns
TypeDescription
com.google.api.resourcenames.ResourceNameFactory

getResourceNameField()

public abstract String getResourceNameField()

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

Returns
TypeDescription
String