Class ApiMessageHttpRequestFormatter<RequestT> (2.8.1)

Version 2.8.1

• 2.55.0 (latest)
• 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 abstract class ApiMessageHttpRequestFormatter<RequestT> implements HttpRequestFormatter<RequestT>

Utility class to parse ApiMessages into various HTTP request parts.

Inheritance

java.lang.Object > ApiMessageHttpRequestFormatter<RequestT>

Implements

com.google.api.gax.httpjson.HttpRequestFormatter<RequestT>

Inherited Members

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.toString()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Type Parameter

Name	Description
RequestT

Constructors

ApiMessageHttpRequestFormatter()

public ApiMessageHttpRequestFormatter()

Methods

<RequestT>newBuilder()

public static ApiMessageHttpRequestFormatter.Builder<RequestT> <RequestT>newBuilder()

Returns

Type	Description
Builder<RequestT>

getPath(RequestT apiMessage)

public String getPath(RequestT apiMessage)

Parameter

Name	Description
apiMessage	RequestT

Returns

Type	Description
String

getPathTemplate()

public abstract PathTemplate getPathTemplate()

Path template for endpoint URL path.

Returns

Type	Description
com.google.api.pathtemplate.PathTemplate

getQueryParamNames()

public abstract Set<String> getQueryParamNames()

Returns

Type	Description
Set<String>

getQueryParamNames(RequestT apiMessage)

public Map<String,List<String>> getQueryParamNames(RequestT apiMessage)

Parameter

Name	Description
apiMessage	RequestT

Returns

Type	Description
Map<String,List<String>>

getRequestBody(ApiMessage apiMessage)

public String getRequestBody(ApiMessage apiMessage)

Parameter

Name	Description
apiMessage	ApiMessage

Returns

Type	Description
String

getResourceNameFactory()

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

getResourceNameField()

public abstract String getResourceNameField()

The name of the field in the RequestT that contains the resource name path.

Returns

Type	Description
String