Interface HttpRequestFormatter<MessageFormatT> (2.47.0)

public interface HttpRequestFormatter<MessageFormatT>

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

Type Parameter
Name Description
MessageFormatT

Methods

getAdditionalPathTemplates()

public default List<PathTemplate> getAdditionalPathTemplates()

Additional (alternative) path templates for endpoint URL path.

Returns
Type Description
List<com.google.api.pathtemplate.PathTemplate>

getPath(MessageFormatT apiMessage)

public abstract String getPath(MessageFormatT apiMessage)
Parameter
Name Description
apiMessage MessageFormatT
Returns
Type Description
String

getPathTemplate()

public abstract PathTemplate getPathTemplate()

Path template for endpoint URL path.

Returns
Type Description
com.google.api.pathtemplate.PathTemplate

getQueryParamNames(MessageFormatT apiMessage)

public abstract Map<String,List<String>> getQueryParamNames(MessageFormatT apiMessage)

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

Parameter
Name Description
apiMessage MessageFormatT
Returns
Type Description
Map<String,List<String>>

getRequestBody(MessageFormatT apiMessage)

public abstract String getRequestBody(MessageFormatT apiMessage)

Return the serialized inner request body of the given message.

Parameter
Name Description
apiMessage MessageFormatT
Returns
Type Description
String