Send feedback
Class ClientSettings<SettingsT> (2.55.0)
Stay organized with collections
Save and categorize content based on your preferences.
Version latest keyboard_arrow_down
public abstract class ClientSettings<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)
protected ClientSettings ( ClientSettings . Builder builder )
Constructs an instance of ClientSettings.
Parameter
Name Description
builderBuilder
Methods
<B>toBuilder()
public abstract B <B>toBuilder ()
Returns
Type Description
B
getApiKey()
public final String getApiKey ()
Gets the API Key that should be used for authentication.
Returns
Type Description
String
getBackgroundExecutorProvider()
public final ExecutorProvider getBackgroundExecutorProvider ()
getClock()
public final ApiClock getClock ()
getCredentialsProvider()
public final CredentialsProvider getCredentialsProvider ()
getEndpoint()
public final String getEndpoint ()
Returns
Type Description
String
getExecutorProvider() (deprecated)
public final ExecutorProvider getExecutorProvider ()
getGdchApiAudience()
public final String getGdchApiAudience ()
Gets the GDCH API audience that was previously set in this Builder
Returns
Type Description
String
public final HeaderProvider getHeaderProvider ()
protected final HeaderProvider getInternalHeaderProvider ()
getQuotaProjectId()
public final String getQuotaProjectId ()
Returns
Type Description
String
getStubSettings()
public final StubSettings getStubSettings ()
getTransportChannelProvider()
public final TransportChannelProvider getTransportChannelProvider ()
getUniverseDomain()
public final String getUniverseDomain ()
Returns
Type Description
String
getWatchdogCheckInterval()
public final Duration getWatchdogCheckInterval ()
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()
public final Duration getWatchdogCheckIntervalDuration ()
getWatchdogProvider()
public final WatchdogProvider getWatchdogProvider ()
toString()
Returns
Type Description
String
Overrides
Send feedback
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-10-30 UTC.
Need to tell us more?
[[["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 2024-10-30 UTC."],[],[]]
