Package com.google.api.gax.rpc

Class RequestParamsBuilder

java.lang.Object

com.google.api.gax.rpc.RequestParamsBuilder

@BetaApi
public class RequestParamsBuilder
extends Object

This builder class builds a request params map that will be used by autogenerated implementation of RequestParamsExtractor.

Method Summary

Modifier and Type	Method	Description
void	add(String headerKey, String fieldValue)	Add an entry to paramsBuilder with key-value pairing of (headerKey, fieldValue).
void	add(String fieldValue, String headerKey, PathTemplate pathTemplate)	Add an entry to paramsBuilder by match-and-extract field values from requests based on pre-configured path templates.
Map<String,String>	build()
static RequestParamsBuilder	create()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

create

public static RequestParamsBuilder create()

add

public void add(String fieldValue,
 String headerKey,
 PathTemplate pathTemplate)

Add an entry to paramsBuilder by match-and-extract field values from requests based on pre-configured path templates. This method is called repeatedly for each configured routing rule parameter, it's possible that the incoming field value from request is null or there is no matches found, we'll continue the match-and-extract process for the next routing rule parameter in such case.

Parameters:

fieldValue - the field value from a request

headerKey - the header key for the routing header param

pathTemplate - PathTemplate the path template used for match-and-extract

add

public void add(String headerKey,
 String fieldValue)

Add an entry to paramsBuilder with key-value pairing of (headerKey, fieldValue). The only validation done is to ensure the headerKey and fieldValue are not null and non-empty. This method is used for implicit routing headers (backwards compatibility).

Parameters:

headerKey - the header key for the routing header param

fieldValue - the field value from a request

build

public Map<String,String> build()