Class ProtoMessageRequestFormatter<RequestT> (2.72.2)
2.75.0 (latest)
2.74.1
2.73.1
2.72.2
2.71.0
2.70.3
2.69.0
2.68.2
2.67.0
2.66.0
2.65.0
2.63.1
2.62.0
2.61.0
2.60.0
2.59.1
2.58.0
2.57.0
2.55.0
2.54.1
2.53.0
2.52.0
2.51.0
2.50.0
2.49.0
2.48.1
2.47.0
2.46.1
2.45.0
2.43.0
2.42.0
2.41.0
2.39.0
2.38.0
2.37.0
2.36.0
2.35.0
2.34.1
2.33.0
2.32.1
2.31.1
2.30.1
2.24.0
2.23.3
2.22.0
2.21.0
2.20.1
2.19.6
2.18.7
2.17.0
2.16.0
2.15.0
2.14.0
2.13.0
2.12.2
2.11.0
2.10.0
2.9.0
2.8.1
2.7.1
public class ProtoMessageRequestFormatter<RequestT> implements HttpRequestFormatter<RequestT>
Creates parts of a HTTP request from a protobuf message.
Implements
com.google.api.gax.httpjson.HttpRequestFormatter<RequestT>
Type Parameter
Name Description
RequestT
Static Methods
public static ProtoMessageRequestFormatter . Builder<RequestT> <RequestT>newBuilder ()
Returns
Type Description
Builder <RequestT >
Methods
public List<PathTemplate> getAdditionalPathTemplates ()
Additional (alternative) path templates for endpoint URL path.
Returns
Type Description
List <com.google.api.pathtemplate.PathTemplate >
public String getPath ( RequestT apiMessage )
Returns the relative URL path created from the path parameters from the given message. Attempts
to match the with the default PathTemplate. If there is not match, it attempts to match with
the templates in the additionalPathTemplates.
Parameter
Name Description
apiMessageRequestT Request object to extract fields from
Returns
Type Description
String Path of a matching valid URL or the default Path URL
public PathTemplate getPathTemplate ()
Path template for endpoint URL path.
Returns
Type Description
com.google.api.pathtemplate.PathTemplate
public Map<String , List<String> > getQueryParamNames ( RequestT apiMessage )
Parameter
Name Description
apiMessageRequestT
getRequestBody(RequestT apiMessage)
public String getRequestBody ( RequestT apiMessage )
Parameter
Name Description
apiMessageRequestT
Returns
Type Description
String
public ProtoMessageRequestFormatter . Builder<RequestT> toBuilder ()
Returns
Type Description
Builder <RequestT >
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 2026-03-11 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 2026-03-11 UTC."],[],[]]
