Class RequestUrlParamsEncoder<RequestT> (2.57.0)

public class RequestUrlParamsEncoder<RequestT> implements RequestParamsEncoder<RequestT>

The request params encoder, which encodes URL-encoded parameters in one URL parameters string.

Inheritance

java.lang.Object > RequestUrlParamsEncoder<RequestT>

Implements

com.google.api.gax.rpc.RequestParamsEncoder<RequestT>

Type Parameter

Name Description
RequestT

Constructors

RequestUrlParamsEncoder(RequestParamsExtractor<RequestT> paramsExtractor)

public RequestUrlParamsEncoder(RequestParamsExtractor<RequestT> paramsExtractor)

Creates the encoder.

Parameter
Name Description
paramsExtractor RequestParamsExtractor<RequestT>

parameters extractor which returns already URL-encoded key-value pairs

Methods

encode(RequestT request)

public String encode(RequestT request)

Encodes the request in a form of a URL parameters string, for example "param1=value+1&param2=value2%26". This method may optionally validate that the name-value paris are URL-encoded. It will URL encode the key and values if there are any non-allowed characters. It will then concatenate the valid individual name-value pairs in a valid URL parameters string.

Note: This will url-encode the key and values during concatenation. Double url-encoding may occur if the input has values that are already url-encoded.

Parameter
Name Description
request RequestT

request message

Returns
Type Description
String