Class RequestUrlParamsEncoder<RequestT> (2.23.0)

Version 2.23.0

• 2.58.0 (latest)
• 2.57.0
• 2.55.0
• 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 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