Class ClientSettings<SettingsT> (2.18.7)

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>

Type Parameter

NameDescription
SettingsT

Constructors

ClientSettings(ClientSettings.Builder builder)

protected ClientSettings(ClientSettings.Builder builder)

Constructs an instance of ClientSettings.

Parameter
NameDescription
builderBuilder

Methods

<B>toBuilder()

public abstract B <B>toBuilder()
Returns
TypeDescription
B

getBackgroundExecutorProvider()

public final ExecutorProvider getBackgroundExecutorProvider()
Returns
TypeDescription
ExecutorProvider

getClock()

public final ApiClock getClock()
Returns
TypeDescription
com.google.api.core.ApiClock

getCredentialsProvider()

public final CredentialsProvider getCredentialsProvider()
Returns
TypeDescription
CredentialsProvider

getEndpoint()

public final String getEndpoint()
Returns
TypeDescription
String

getExecutorProvider() (deprecated)

public final ExecutorProvider getExecutorProvider()

Deprecated. Please use #getBackgroundExecutorProvider()

Returns
TypeDescription
ExecutorProvider

getHeaderProvider()

public final HeaderProvider getHeaderProvider()
Returns
TypeDescription
HeaderProvider

getInternalHeaderProvider()

protected final HeaderProvider getInternalHeaderProvider()
Returns
TypeDescription
HeaderProvider

getQuotaProjectId()

public final String getQuotaProjectId()
Returns
TypeDescription
String

getStubSettings()

public final StubSettings getStubSettings()
Returns
TypeDescription
StubSettings

getTransportChannelProvider()

public final TransportChannelProvider getTransportChannelProvider()
Returns
TypeDescription
TransportChannelProvider

getWatchdogCheckInterval()

public final Duration getWatchdogCheckInterval()
Returns
TypeDescription
org.threeten.bp.Duration

getWatchdogProvider()

public final WatchdogProvider getWatchdogProvider()
Returns
TypeDescription
WatchdogProvider

toString()

public String toString()
Returns
TypeDescription
String
Overrides