Class ApiMessageHttpRequestFormatter<RequestT> (2.13.0)
Stay organized with collections
Save and categorize content based on your preferences.
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.
| 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.
| 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.
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-04-04 UTC.
[{
"type": "thumb-down",
"id": "hardToUnderstand",
"label":"Hard to understand"
},{
"type": "thumb-down",
"id": "incorrectInformationOrSampleCode",
"label":"Incorrect information or sample code"
},{
"type": "thumb-down",
"id": "missingTheInformationSamplesINeed",
"label":"Missing the information/samples I need"
},{
"type": "thumb-down",
"id": "otherDown",
"label":"Other"
}]
[{
"type": "thumb-up",
"id": "easyToUnderstand",
"label":"Easy to understand"
},{
"type": "thumb-up",
"id": "solvedMyProblem",
"label":"Solved my problem"
},{
"type": "thumb-up",
"id": "otherUp",
"label":"Other"
}]
