Class ClientSettings<SettingsT> (2.72.2)
- 2.72.2 (latest)
- 2.72.1
- 2.71.0
- 2.70.3
- 2.69.0
- 2.68.2
- 2.67.0
- 2.66.0
- 2.65.0
- 2.63.1
- 2.62.0
- 2.61.0
- 2.60.0
- 2.59.1
- 2.58.0
- 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
publicabstractclassClientSettings<SettingsT>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.
Type Parameter | |
|---|---|
| Name | Description |
SettingsT | |
Constructors
ClientSettings(ClientSettings.Builder builder)
protectedClientSettings(ClientSettings.Builderbuilder)Constructs an instance of ClientSettings.
| Parameter | |
|---|---|
| Name | Description |
builder | Builder |
Methods
<B>toBuilder()
publicabstractB<B>toBuilder()| Returns | |
|---|---|
| Type | Description |
B | |
getApiKey()
publicfinalStringgetApiKey()Gets the API Key that should be used for authentication.
| Returns | |
|---|---|
| Type | Description |
String | |
getBackgroundExecutorProvider()
publicfinalExecutorProvidergetBackgroundExecutorProvider()| Returns | |
|---|---|
| Type | Description |
ExecutorProvider | |
getClock()
publicfinalApiClockgetClock()| Returns | |
|---|---|
| Type | Description |
ApiClock | |
getCredentialsProvider()
publicfinalCredentialsProvidergetCredentialsProvider()| Returns | |
|---|---|
| Type | Description |
CredentialsProvider | |
getEndpoint()
publicfinalStringgetEndpoint()| Returns | |
|---|---|
| Type | Description |
String | |
getExecutorProvider() (deprecated)
publicfinalExecutorProvidergetExecutorProvider()Deprecated.Please use#getBackgroundExecutorProvider()
| Returns | |
|---|---|
| Type | Description |
ExecutorProvider | |
getGdchApiAudience()
publicfinalStringgetGdchApiAudience()Gets the GDCH API audience that was previously set in this Builder
| Returns | |
|---|---|
| Type | Description |
String | |
getHeaderProvider()
publicfinalHeaderProvidergetHeaderProvider()| Returns | |
|---|---|
| Type | Description |
HeaderProvider | |
getInternalHeaderProvider()
protectedfinalHeaderProvidergetInternalHeaderProvider()| Returns | |
|---|---|
| Type | Description |
HeaderProvider | |
getQuotaProjectId()
publicfinalStringgetQuotaProjectId()| Returns | |
|---|---|
| Type | Description |
String | |
getStubSettings()
publicfinalStubSettingsgetStubSettings()| Returns | |
|---|---|
| Type | Description |
StubSettings | |
getTransportChannelProvider()
publicfinalTransportChannelProvidergetTransportChannelProvider()| Returns | |
|---|---|
| Type | Description |
TransportChannelProvider | |
getUniverseDomain()
publicfinalStringgetUniverseDomain()| Returns | |
|---|---|
| Type | Description |
String | |
getWatchdogCheckInterval()
publicfinalDurationgetWatchdogCheckInterval()Obsolete
Use getWatchdogCheckIntervalDuration() instead
This feature is stable for usage in this major version, but may be deprecated in a future release.
This method is obsolete. Use#getWatchdogCheckIntervalDuration() instead.
| Returns | |
|---|---|
| Type | Description |
org.threeten.bp.Duration | |
getWatchdogCheckIntervalDuration()
publicfinalDurationgetWatchdogCheckIntervalDuration()| Returns | |
|---|---|
| Type | Description |
Duration | |
getWatchdogProvider()
publicfinalWatchdogProvidergetWatchdogProvider()| Returns | |
|---|---|
| Type | Description |
WatchdogProvider | |
toString()
publicStringtoString()| Returns | |
|---|---|
| Type | Description |
String | |
Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-12-17 UTC.