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).
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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[[["\u003cp\u003eThis webpage provides documentation for the \u003ccode\u003eRequestParamsBuilder\u003c/code\u003e class in the Google API Client Library for Java, with the latest version being 2.63.1.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eRequestParamsBuilder\u003c/code\u003e is a utility class used to build a request parameters map for use by the auto-generated implementation of \u003ccode\u003eRequestParamsExtractor\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eThe library is currently in a beta stage and might be subject to changes that are not compatible with other pre-GA versions, with potentially limited support.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eRequestParamsBuilder\u003c/code\u003e class includes methods for adding routing parameters, either by direct key-value pairs with the \u003ccode\u003eadd\u003c/code\u003e method or by matching and extracting values from request fields based on path templates.\u003c/p\u003e\n"],["\u003cp\u003eThere is a wide array of version history available, ranging from the latest 2.63.1 to older versions such as 2.7.1, showcasing the continuous evolution of the library.\u003c/p\u003e\n"]]],[],null,["# Class RequestParamsBuilder (2.69.0)\n\nVersion latestkeyboard_arrow_down\n\n- [2.69.0 (latest)](/java/docs/reference/gax/latest/com.google.api.gax.rpc.RequestParamsBuilder)\n- [2.68.2](/java/docs/reference/gax/2.68.2/com.google.api.gax.rpc.RequestParamsBuilder)\n- [2.67.0](/java/docs/reference/gax/2.67.0/com.google.api.gax.rpc.RequestParamsBuilder)\n- [2.66.0](/java/docs/reference/gax/2.66.0/com.google.api.gax.rpc.RequestParamsBuilder)\n- [2.65.0](/java/docs/reference/gax/2.65.0/com.google.api.gax.rpc.RequestParamsBuilder)\n- [2.63.1](/java/docs/reference/gax/2.63.1/com.google.api.gax.rpc.RequestParamsBuilder)\n- [2.62.0](/java/docs/reference/gax/2.62.0/com.google.api.gax.rpc.RequestParamsBuilder)\n- [2.61.0](/java/docs/reference/gax/2.61.0/com.google.api.gax.rpc.RequestParamsBuilder)\n- [2.60.0](/java/docs/reference/gax/2.60.0/com.google.api.gax.rpc.RequestParamsBuilder)\n- [2.59.1](/java/docs/reference/gax/2.59.1/com.google.api.gax.rpc.RequestParamsBuilder)\n- [2.58.0](/java/docs/reference/gax/2.58.0/com.google.api.gax.rpc.RequestParamsBuilder)\n- [2.57.0](/java/docs/reference/gax/2.57.0/com.google.api.gax.rpc.RequestParamsBuilder)\n- [2.55.0](/java/docs/reference/gax/2.55.0/com.google.api.gax.rpc.RequestParamsBuilder)\n- [2.54.1](/java/docs/reference/gax/2.54.1/com.google.api.gax.rpc.RequestParamsBuilder)\n- [2.53.0](/java/docs/reference/gax/2.53.0/com.google.api.gax.rpc.RequestParamsBuilder)\n- [2.52.0](/java/docs/reference/gax/2.52.0/com.google.api.gax.rpc.RequestParamsBuilder)\n- [2.51.0](/java/docs/reference/gax/2.51.0/com.google.api.gax.rpc.RequestParamsBuilder)\n- [2.50.0](/java/docs/reference/gax/2.50.0/com.google.api.gax.rpc.RequestParamsBuilder)\n- [2.49.0](/java/docs/reference/gax/2.49.0/com.google.api.gax.rpc.RequestParamsBuilder)\n- [2.48.1](/java/docs/reference/gax/2.48.1/com.google.api.gax.rpc.RequestParamsBuilder)\n- [2.47.0](/java/docs/reference/gax/2.47.0/com.google.api.gax.rpc.RequestParamsBuilder)\n- [2.46.1](/java/docs/reference/gax/2.46.1/com.google.api.gax.rpc.RequestParamsBuilder)\n- [2.45.0](/java/docs/reference/gax/2.45.0/com.google.api.gax.rpc.RequestParamsBuilder)\n- [2.43.0](/java/docs/reference/gax/2.43.0/com.google.api.gax.rpc.RequestParamsBuilder)\n- [2.42.0](/java/docs/reference/gax/2.42.0/com.google.api.gax.rpc.RequestParamsBuilder)\n- [2.41.0](/java/docs/reference/gax/2.41.0/com.google.api.gax.rpc.RequestParamsBuilder)\n- [2.39.0](/java/docs/reference/gax/2.39.0/com.google.api.gax.rpc.RequestParamsBuilder)\n- [2.38.0](/java/docs/reference/gax/2.38.0/com.google.api.gax.rpc.RequestParamsBuilder)\n- [2.37.0](/java/docs/reference/gax/2.37.0/com.google.api.gax.rpc.RequestParamsBuilder)\n- [2.36.0](/java/docs/reference/gax/2.36.0/com.google.api.gax.rpc.RequestParamsBuilder)\n- [2.35.0](/java/docs/reference/gax/2.35.0/com.google.api.gax.rpc.RequestParamsBuilder)\n- [2.34.1](/java/docs/reference/gax/2.34.1/com.google.api.gax.rpc.RequestParamsBuilder)\n- [2.33.0](/java/docs/reference/gax/2.33.0/com.google.api.gax.rpc.RequestParamsBuilder)\n- [2.32.1](/java/docs/reference/gax/2.32.1/com.google.api.gax.rpc.RequestParamsBuilder)\n- [2.31.1](/java/docs/reference/gax/2.31.1/com.google.api.gax.rpc.RequestParamsBuilder)\n- [2.30.1](/java/docs/reference/gax/2.30.1/com.google.api.gax.rpc.RequestParamsBuilder)\n- [2.24.0](/java/docs/reference/gax/2.24.0/com.google.api.gax.rpc.RequestParamsBuilder)\n- [2.23.3](/java/docs/reference/gax/2.23.3/com.google.api.gax.rpc.RequestParamsBuilder)\n- [2.22.0](/java/docs/reference/gax/2.22.0/com.google.api.gax.rpc.RequestParamsBuilder)\n- [2.21.0](/java/docs/reference/gax/2.21.0/com.google.api.gax.rpc.RequestParamsBuilder)\n- [2.20.1](/java/docs/reference/gax/2.20.1/com.google.api.gax.rpc.RequestParamsBuilder)\n- [2.19.6](/java/docs/reference/gax/2.19.6/com.google.api.gax.rpc.RequestParamsBuilder)\n- [2.18.7](/java/docs/reference/gax/2.18.7/com.google.api.gax.rpc.RequestParamsBuilder)\n- [2.17.0](/java/docs/reference/gax/2.17.0/com.google.api.gax.rpc.RequestParamsBuilder)\n- [2.16.0](/java/docs/reference/gax/2.16.0/com.google.api.gax.rpc.RequestParamsBuilder)\n- [2.15.0](/java/docs/reference/gax/2.15.0/com.google.api.gax.rpc.RequestParamsBuilder)\n- [2.14.0](/java/docs/reference/gax/2.14.0/com.google.api.gax.rpc.RequestParamsBuilder)\n- [2.13.0](/java/docs/reference/gax/2.13.0/com.google.api.gax.rpc.RequestParamsBuilder)\n- [2.12.2](/java/docs/reference/gax/2.12.2/com.google.api.gax.rpc.RequestParamsBuilder)\n- [2.11.0](/java/docs/reference/gax/2.11.0/com.google.api.gax.rpc.RequestParamsBuilder)\n- [2.10.0](/java/docs/reference/gax/2.10.0/com.google.api.gax.rpc.RequestParamsBuilder)\n- [2.9.0](/java/docs/reference/gax/2.9.0/com.google.api.gax.rpc.RequestParamsBuilder)\n- [2.8.1](/java/docs/reference/gax/2.8.1/com.google.api.gax.rpc.RequestParamsBuilder)\n- [2.7.1](/java/docs/reference/gax/2.7.1/com.google.api.gax.rpc.RequestParamsBuilder) \n| **Beta**\n|\n|\n| This library is covered by the [Pre-GA Offerings Terms](/terms/service-terms#1)\n| of the Terms of Service. Pre-GA libraries might have limited support,\n| and changes to pre-GA libraries might not be compatible with other pre-GA versions.\n| For more information, see the\n[launch stage descriptions](/products#product-launch-stages). \n\n public class RequestParamsBuilder\n\nThis builder class builds a request params map that will be used by autogenerated implementation\nof [RequestParamsExtractor](/java/docs/reference/gax/latest/com.google.api.gax.rpc.RequestParamsExtractor). \n\nInheritance\n-----------\n\n[java.lang.Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html) \\\u003e RequestParamsBuilder \n\nInherited Members\n-----------------\n\n[Object.clone()](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--) \n[Object.equals(Object)](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-) \n[Object.finalize()](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--) \n[Object.getClass()](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--) \n[Object.hashCode()](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--) \n[Object.notify()](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--) \n[Object.notifyAll()](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--) \n[Object.toString()](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--) \n[Object.wait()](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--) \n[Object.wait(long)](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-) \n[Object.wait(long,int)](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-)\n\nStatic Methods\n--------------\n\n### create()\n\n public static RequestParamsBuilder create()\n\nMethods\n-------\n\n### add(String headerKey, String fieldValue)\n\n public void add(String headerKey, String fieldValue)\n\nAdd an entry to paramsBuilder with key-value pairing of (headerKey, fieldValue). The only\nvalidation done is to ensure the headerKey and fieldValue are not null and non-empty. This\nmethod is used for implicit routing headers (backwards compatibility).\n\n### add(String fieldValue, String headerKey, PathTemplate pathTemplate)\n\n public void add(String fieldValue, String headerKey, PathTemplate pathTemplate)\n\nAdd an entry to paramsBuilder by match-and-extract field values from requests based on\npre-configured path templates. This method is called repeatedly for each configured routing\nrule parameter, it's possible that the incoming field value from request is null or there is no\nmatches found, we'll continue the match-and-extract process for the next routing rule parameter\nin such case.\n\n### build()\n\n public Map\u003cString,String\u003e build()"]]
