Send feedback
Class ApiMessageHttpRequestFormatter<RequestT> (2.16.0)
Stay organized with collections
Save and categorize content based on your preferences.
Version 2.16.0 keyboard_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
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
Send feedback
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 2024-10-30 UTC.
Need to tell us more?
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-10-30 UTC."],[],[]]
