Class RequestUrlParamsEncoder<RequestT> (2.16.0)

public class RequestUrlParamsEncoder<RequestT> implements RequestParamsEncoder<RequestT>

The request params encoder, which encodes URL-encoded parameters in one URL parameters string. This class expects that name-value pairs, returned from parameters extractor are already URL-encoded and can perform optional validation of that, but does not encode the name-value pairs themselves.

Inheritance

java.lang.Object > RequestUrlParamsEncoder<RequestT>

Implements

com.google.api.gax.rpc.RequestParamsEncoder<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

RequestUrlParamsEncoder(RequestParamsExtractor<RequestT> paramsExtractor, boolean validateExtractedParameters)

public RequestUrlParamsEncoder(RequestParamsExtractor<RequestT> paramsExtractor, boolean validateExtractedParameters)

Creates the encoder.

Parameters

Name	Description
paramsExtractor	`RequestParamsExtractor<RequestT>` parameters extractor which returns already URL-encoded key-value pairs
validateExtractedParameters	`boolean` `true` if this class should validate that the extracted parameters are URL-encoded, `false` otherwise

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, but it will not perform the actual encoding of them (it will only concatenate the valid individual name-value pairs in a valid URL parameters string). This is so, because in most practical cases the name-value paris are already URL-encoded.

Parameter

Name	Description
request	`RequestT` request message

Returns

Type	Description
String