Class ApiMessageHttpRequestFormatter<RequestT> (2.12.2)
Note: Some or all of the information on this page might not apply
to Trusted Cloud. For a list of services that are available in
Trusted Cloud, see Services available for
Trusted Cloud .
Version 2.12.2keyboard_arrow_down
public abstract class ApiMessageHttpRequestFormatter<RequestT> implements HttpRequestFormatter<RequestT>
Utility class to parse ApiMessages into various HTTP request parts.
Implements
com.google.api.gax.httpjson.HttpRequestFormatter<RequestT> Type Parameter
Name Description
RequestT
Static Methods
public static ApiMessageHttpRequestFormatter . Builder<RequestT> <RequestT>newBuilder ()
Returns
Constructors
public ApiMessageHttpRequestFormatter ()
Methods
public String getPath ( RequestT apiMessage )
Parameter
Name Description
apiMessage RequestT
Returns
public abstract PathTemplate getPathTemplate ()
Path template for endpoint URL path.
Returns
Type Description
com.google.api.pathtemplate.PathTemplate
public abstract Set<String> getQueryParamNames ()
Returns
public Map<String , List<String> > getQueryParamNames ( RequestT apiMessage )
Parameter
Name Description
apiMessage RequestT
Returns
getRequestBody(ApiMessage apiMessage)
public String getRequestBody ( ApiMessage apiMessage )
Parameter
Returns
public abstract ResourceNameFactory getResourceNameFactory ()
A ResourceNameFactory that can parse the resource name String into a ResourceName object.
Returns
Type Description
com.google.api.resourcenames.ResourceNameFactory
public abstract String getResourceNameField ()
The name of the field in the RequestT that contains the resource name path.
Returns
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-09-30 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-30 UTC."],[],[],null,[]]
