Package com.google.api.gax.rpc

Class ClientSettings<SettingsT extends ClientSettings<SettingsT>>

java.lang.Object

com.google.api.gax.rpc.ClientSettings<SettingsT>

@NullMarked
public abstract class ClientSettings<SettingsT extends ClientSettings<SettingsT>>
extends Object

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.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ClientSettings.Builder<SettingsT extends ClientSettings<SettingsT>,B extends ClientSettings.Builder<SettingsT,B>>

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ClientSettings(ClientSettings.Builder builder)	Constructs an instance of ClientSettings.

Method Summary

Modifier and Type	Method	Description
final String	getApiKey()	Gets the API Key that should be used for authentication.
final ExecutorProvider	getBackgroundExecutorProvider()
final ApiClock	getClock()
final CredentialsProvider	getCredentialsProvider()
final String	getEndpoint()
final ExecutorProvider	getExecutorProvider()	Deprecated. Please use getBackgroundExecutorProvider()
final String	getGdchApiAudience()	Gets the GDCH API audience that was previously set in this Builder
final HeaderProvider	getHeaderProvider()
protected final HeaderProvider	getInternalHeaderProvider()
final String	getQuotaProjectId()
final StubSettings	getStubSettings()
final TransportChannelProvider	getTransportChannelProvider()
final String	getUniverseDomain()
final org.threeten.bp.Duration	getWatchdogCheckInterval()	This method is obsolete.
final Duration	getWatchdogCheckIntervalDuration()
final @Nullable WatchdogProvider	getWatchdogProvider()
abstract <B extends ClientSettings.Builder<SettingsT, B>> B	toBuilder()
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

ClientSettings

protected ClientSettings(ClientSettings.Builder builder)
                  throws IOException

Constructs an instance of ClientSettings.

Throws:

IOException

Method Details

getStubSettings

public final StubSettings getStubSettings()

getExecutorProvider

@Deprecated
public final ExecutorProvider getExecutorProvider()

Deprecated.

Please use getBackgroundExecutorProvider()

getBackgroundExecutorProvider

public final ExecutorProvider getBackgroundExecutorProvider()

getTransportChannelProvider

public final TransportChannelProvider getTransportChannelProvider()

getCredentialsProvider

public final CredentialsProvider getCredentialsProvider()

getHeaderProvider

public final HeaderProvider getHeaderProvider()

getInternalHeaderProvider

protected final HeaderProvider getInternalHeaderProvider()

getClock

public final ApiClock getClock()

getUniverseDomain

public final String getUniverseDomain()

getEndpoint

public final String getEndpoint()

getQuotaProjectId

public final String getQuotaProjectId()

getWatchdogProvider

public final @Nullable WatchdogProvider getWatchdogProvider()

getApiKey

public final String getApiKey()

Gets the API Key that should be used for authentication.

getWatchdogCheckInterval

@ObsoleteApi("Use getWatchdogCheckIntervalDuration() instead")
public final org.threeten.bp.Duration getWatchdogCheckInterval()

This method is obsolete. Use getWatchdogCheckIntervalDuration() instead.

getWatchdogCheckIntervalDuration

public final Duration getWatchdogCheckIntervalDuration()

getGdchApiAudience

public final String getGdchApiAudience()

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

toString

public String toString()

Overrides:

toString in class Object

toBuilder

public abstract <B extends ClientSettings.Builder<SettingsT,
B>>
B toBuilder()