A base settings class to configure a client class.
This base class includes settings that are applicable to all services, which includes things
like settings for creating an executor, credentials, transport-specific settings, and identifiers
for http headers.
If no ExecutorProvider is set, then InstantiatingExecutorProvider will be used, which creates
a default executor.
[[["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-08-28 UTC."],[[["\u003cp\u003eThis document provides comprehensive reference information for \u003ccode\u003eClientSettings\u003c/code\u003e in the Google API Client Library for Java, including details on its versions, inheritance, constructors, and methods.\u003c/p\u003e\n"],["\u003cp\u003eThe latest version of \u003ccode\u003eClientSettings\u003c/code\u003e is 2.63.1, with numerous prior versions also available, ranging from 2.62.0 down to 2.7.1.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eClientSettings\u003c/code\u003e is an abstract base class that helps configure client classes with various settings, such as executor, credentials, transport settings, and HTTP header identifiers.\u003c/p\u003e\n"],["\u003cp\u003eThe class offers methods to retrieve settings like API key, background executor provider, credentials provider, endpoint, header provider, transport channel provider, and more, with a deprecated method for executor provider.\u003c/p\u003e\n"],["\u003cp\u003eThe class enables management of settings for background tasks and API communication, including watchdog functionality for monitoring and maintaining operations.\u003c/p\u003e\n"]]],[],null,["# Class ClientSettings<SettingsT> (2.69.0)\n\nVersion latestkeyboard_arrow_down\n\n- [2.69.0 (latest)](/java/docs/reference/gax/latest/com.google.api.gax.rpc.ClientSettings)\n- [2.68.2](/java/docs/reference/gax/2.68.2/com.google.api.gax.rpc.ClientSettings)\n- [2.67.0](/java/docs/reference/gax/2.67.0/com.google.api.gax.rpc.ClientSettings)\n- [2.66.0](/java/docs/reference/gax/2.66.0/com.google.api.gax.rpc.ClientSettings)\n- [2.65.0](/java/docs/reference/gax/2.65.0/com.google.api.gax.rpc.ClientSettings)\n- [2.63.1](/java/docs/reference/gax/2.63.1/com.google.api.gax.rpc.ClientSettings)\n- [2.62.0](/java/docs/reference/gax/2.62.0/com.google.api.gax.rpc.ClientSettings)\n- [2.61.0](/java/docs/reference/gax/2.61.0/com.google.api.gax.rpc.ClientSettings)\n- [2.60.0](/java/docs/reference/gax/2.60.0/com.google.api.gax.rpc.ClientSettings)\n- [2.59.1](/java/docs/reference/gax/2.59.1/com.google.api.gax.rpc.ClientSettings)\n- [2.58.0](/java/docs/reference/gax/2.58.0/com.google.api.gax.rpc.ClientSettings)\n- [2.57.0](/java/docs/reference/gax/2.57.0/com.google.api.gax.rpc.ClientSettings)\n- [2.55.0](/java/docs/reference/gax/2.55.0/com.google.api.gax.rpc.ClientSettings)\n- [2.54.1](/java/docs/reference/gax/2.54.1/com.google.api.gax.rpc.ClientSettings)\n- [2.53.0](/java/docs/reference/gax/2.53.0/com.google.api.gax.rpc.ClientSettings)\n- [2.52.0](/java/docs/reference/gax/2.52.0/com.google.api.gax.rpc.ClientSettings)\n- [2.51.0](/java/docs/reference/gax/2.51.0/com.google.api.gax.rpc.ClientSettings)\n- [2.50.0](/java/docs/reference/gax/2.50.0/com.google.api.gax.rpc.ClientSettings)\n- [2.49.0](/java/docs/reference/gax/2.49.0/com.google.api.gax.rpc.ClientSettings)\n- [2.48.1](/java/docs/reference/gax/2.48.1/com.google.api.gax.rpc.ClientSettings)\n- [2.47.0](/java/docs/reference/gax/2.47.0/com.google.api.gax.rpc.ClientSettings)\n- [2.46.1](/java/docs/reference/gax/2.46.1/com.google.api.gax.rpc.ClientSettings)\n- [2.45.0](/java/docs/reference/gax/2.45.0/com.google.api.gax.rpc.ClientSettings)\n- [2.43.0](/java/docs/reference/gax/2.43.0/com.google.api.gax.rpc.ClientSettings)\n- [2.42.0](/java/docs/reference/gax/2.42.0/com.google.api.gax.rpc.ClientSettings)\n- [2.41.0](/java/docs/reference/gax/2.41.0/com.google.api.gax.rpc.ClientSettings)\n- [2.39.0](/java/docs/reference/gax/2.39.0/com.google.api.gax.rpc.ClientSettings)\n- [2.38.0](/java/docs/reference/gax/2.38.0/com.google.api.gax.rpc.ClientSettings)\n- [2.37.0](/java/docs/reference/gax/2.37.0/com.google.api.gax.rpc.ClientSettings)\n- [2.36.0](/java/docs/reference/gax/2.36.0/com.google.api.gax.rpc.ClientSettings)\n- [2.35.0](/java/docs/reference/gax/2.35.0/com.google.api.gax.rpc.ClientSettings)\n- [2.34.1](/java/docs/reference/gax/2.34.1/com.google.api.gax.rpc.ClientSettings)\n- [2.33.0](/java/docs/reference/gax/2.33.0/com.google.api.gax.rpc.ClientSettings)\n- [2.32.1](/java/docs/reference/gax/2.32.1/com.google.api.gax.rpc.ClientSettings)\n- [2.31.1](/java/docs/reference/gax/2.31.1/com.google.api.gax.rpc.ClientSettings)\n- [2.30.1](/java/docs/reference/gax/2.30.1/com.google.api.gax.rpc.ClientSettings)\n- [2.24.0](/java/docs/reference/gax/2.24.0/com.google.api.gax.rpc.ClientSettings)\n- [2.23.3](/java/docs/reference/gax/2.23.3/com.google.api.gax.rpc.ClientSettings)\n- [2.22.0](/java/docs/reference/gax/2.22.0/com.google.api.gax.rpc.ClientSettings)\n- [2.21.0](/java/docs/reference/gax/2.21.0/com.google.api.gax.rpc.ClientSettings)\n- [2.20.1](/java/docs/reference/gax/2.20.1/com.google.api.gax.rpc.ClientSettings)\n- [2.19.6](/java/docs/reference/gax/2.19.6/com.google.api.gax.rpc.ClientSettings)\n- [2.18.7](/java/docs/reference/gax/2.18.7/com.google.api.gax.rpc.ClientSettings)\n- [2.17.0](/java/docs/reference/gax/2.17.0/com.google.api.gax.rpc.ClientSettings)\n- [2.16.0](/java/docs/reference/gax/2.16.0/com.google.api.gax.rpc.ClientSettings)\n- [2.15.0](/java/docs/reference/gax/2.15.0/com.google.api.gax.rpc.ClientSettings)\n- [2.14.0](/java/docs/reference/gax/2.14.0/com.google.api.gax.rpc.ClientSettings)\n- [2.13.0](/java/docs/reference/gax/2.13.0/com.google.api.gax.rpc.ClientSettings)\n- [2.12.2](/java/docs/reference/gax/2.12.2/com.google.api.gax.rpc.ClientSettings)\n- [2.11.0](/java/docs/reference/gax/2.11.0/com.google.api.gax.rpc.ClientSettings)\n- [2.10.0](/java/docs/reference/gax/2.10.0/com.google.api.gax.rpc.ClientSettings)\n- [2.9.0](/java/docs/reference/gax/2.9.0/com.google.api.gax.rpc.ClientSettings)\n- [2.8.1](/java/docs/reference/gax/2.8.1/com.google.api.gax.rpc.ClientSettings)\n- [2.7.1](/java/docs/reference/gax/2.7.1/com.google.api.gax.rpc.ClientSettings) \n\n public abstract class ClientSettings\u003cSettingsT\u003e\n\nA base settings class to configure a client class.\n\nThis base class includes settings that are applicable to all services, which includes things\nlike settings for creating an executor, credentials, transport-specific settings, and identifiers\nfor http headers.\n\nIf no ExecutorProvider is set, then InstantiatingExecutorProvider will be used, which creates\na default executor. \n\nInheritance\n-----------\n\n[java.lang.Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html) \\\u003e ClientSettings\\\u003cSettingsT\\\u003e \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\nConstructors\n------------\n\n### ClientSettings(ClientSettings.Builder builder)\n\n protected ClientSettings(ClientSettings.Builder builder)\n\nConstructs an instance of ClientSettings.\n\nMethods\n-------\n\n### \\\u003cB\\\u003etoBuilder()\n\n public abstract B \u003cB\u003etoBuilder()\n\n### getApiKey()\n\n public final String getApiKey()\n\nGets the API Key that should be used for authentication.\n\n### getBackgroundExecutorProvider()\n\n public final ExecutorProvider getBackgroundExecutorProvider()\n\n### getClock()\n\n public final ApiClock getClock()\n\n### getCredentialsProvider()\n\n public final CredentialsProvider getCredentialsProvider()\n\n### getEndpoint()\n\n public final String getEndpoint()\n\n### getExecutorProvider() (deprecated)\n\n public final ExecutorProvider getExecutorProvider()\n\n**Deprecated.** *Please use [#getBackgroundExecutorProvider()](/java/docs/reference/gax/latest/com.google.api.gax.rpc.ClientSettings#com_google_api_gax_rpc_ClientSettings_getBackgroundExecutorProvider__)*\n\n### getGdchApiAudience()\n\n public final String getGdchApiAudience()\n\nGets the GDCH API audience that was previously set in this Builder\n\n### getHeaderProvider()\n\n public final HeaderProvider getHeaderProvider()\n\n### getInternalHeaderProvider()\n\n protected final HeaderProvider getInternalHeaderProvider()\n\n### getQuotaProjectId()\n\n public final String getQuotaProjectId()\n\n### getStubSettings()\n\n public final StubSettings getStubSettings()\n\n### getTransportChannelProvider()\n\n public final TransportChannelProvider getTransportChannelProvider()\n\n### getUniverseDomain()\n\n public final String getUniverseDomain()\n\n### getWatchdogCheckInterval()\n\n public final Duration getWatchdogCheckInterval()\n\n| **Obsolete**\n|\n| *Use getWatchdogCheckIntervalDuration() instead*\n|\n| This feature is stable for usage in this major version, but may be deprecated in a future release.\n\nThis method is obsolete. Use [#getWatchdogCheckIntervalDuration()](/java/docs/reference/gax/latest/com.google.api.gax.rpc.ClientSettings#com_google_api_gax_rpc_ClientSettings_getWatchdogCheckIntervalDuration__) instead.\n\n### getWatchdogCheckIntervalDuration()\n\n public final Duration getWatchdogCheckIntervalDuration()\n\n### getWatchdogProvider()\n\n public final WatchdogProvider getWatchdogProvider()\n\n### toString()\n\n public String toString()\n\n**Overrides** \n[Object.toString()](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--)"]]
