Package com.google.api.gax.rpc

Class ClientSettings<SettingsT extends ClientSettings<SettingsT>>

java.lang.Object

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

public abstract class ClientSettings<SettingsT extends ClientSettings<SettingsT>>
extends java.lang.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
ExecutorProvider	getBackgroundExecutorProvider()
com.google.api.core.ApiClock	getClock()
CredentialsProvider	getCredentialsProvider()
java.lang.String	getEndpoint()
ExecutorProvider	getExecutorProvider()	Deprecated. Please use getBackgroundExecutorProvider()
HeaderProvider	getHeaderProvider()
protected HeaderProvider	getInternalHeaderProvider()
java.lang.String	getQuotaProjectId()
StubSettings	getStubSettings()
TransportChannelProvider	getTransportChannelProvider()
org.threeten.bp.Duration	getWatchdogCheckInterval()
WatchdogProvider	getWatchdogProvider()
abstract <B extends ClientSettings.Builder<SettingsT,B>> B	toBuilder()
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ClientSettings

protected ClientSettings(ClientSettings.Builder builder)
                  throws java.io.IOException

Constructs an instance of ClientSettings.

Throws:

java.io.IOException

Method Detail

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 com.google.api.core.ApiClock getClock()

getEndpoint

public final java.lang.String getEndpoint()

getQuotaProjectId

public final java.lang.String getQuotaProjectId()

getWatchdogProvider

@Nullable
public final WatchdogProvider getWatchdogProvider()

getWatchdogCheckInterval

@Nonnull
public final org.threeten.bp.Duration getWatchdogCheckInterval()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

toBuilder

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