Class ClientSettings<SettingsT> (2.71.0)

Version latest

• 2.71.0 (latest)
• 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

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.

Inheritance

java.lang.Object > ClientSettings<SettingsT>

Inherited Members

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.toString()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Type Parameter
Name	Description
SettingsT

Constructors

ClientSettings(ClientSettings.Builder builder)

protected ClientSettings(ClientSettings.Builder builder)

Constructs an instance of ClientSettings.

Parameter
Name	Description
builder	Builder

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()

Returns
Type	Description
ExecutorProvider

getClock()

public final ApiClock getClock()

Returns
Type	Description
ApiClock

getCredentialsProvider()

public final CredentialsProvider getCredentialsProvider()

Returns
Type	Description
CredentialsProvider

getEndpoint()

public final String getEndpoint()

Returns
Type	Description
String

getExecutorProvider() (deprecated)

public final ExecutorProvider getExecutorProvider()

Deprecated. Please use #getBackgroundExecutorProvider()

Returns
Type	Description
ExecutorProvider

getGdchApiAudience()

public final String getGdchApiAudience()

Gets the GDCH API audience that was previously set in this Builder

Returns
Type	Description
String

getHeaderProvider()

public final HeaderProvider getHeaderProvider()

Returns
Type	Description
HeaderProvider

getInternalHeaderProvider()

protected final HeaderProvider getInternalHeaderProvider()

Returns
Type	Description
HeaderProvider

getQuotaProjectId()

public final String getQuotaProjectId()

Returns
Type	Description
String

getStubSettings()

public final StubSettings getStubSettings()

Returns
Type	Description
StubSettings

getTransportChannelProvider()

public final TransportChannelProvider getTransportChannelProvider()

Returns
Type	Description
TransportChannelProvider

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()

Returns
Type	Description
Duration

getWatchdogProvider()

public final WatchdogProvider getWatchdogProvider()

Returns
Type	Description
WatchdogProvider

toString()

public String toString()

Returns
Type	Description
String

Overrides

Object.toString()