Class StubSettings<SettingsT> (2.10.0) 

public abstract class StubSettings<SettingsT>

A base settings class to configure a client stub 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 > StubSettings<SettingsT>

Type Parameter

NameDescription
SettingsT

Constructors

StubSettings(StubSettings.Builder builder)

protected StubSettings(StubSettings.Builder builder)

Constructs an instance of StubSettings.

Parameter
NameDescription
builderBuilder

Methods

getApiKey()

public final String getApiKey()
Returns
TypeDescription
String

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

getMtlsEndpoint()

public final String getMtlsEndpoint()
Returns
TypeDescription
String

getQuotaProjectId()

public final String getQuotaProjectId()
Returns
TypeDescription
String

getStreamWatchdogCheckInterval()

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

getStreamWatchdogProvider()

public final WatchdogProvider getStreamWatchdogProvider()
Returns
TypeDescription
WatchdogProvider

getTracerFactory()

public ApiTracerFactory getTracerFactory()

Gets the configured ApiTracerFactory that will be used to generate traces for operations.

Returns
TypeDescription
ApiTracerFactory

getTransportChannelProvider()

public final TransportChannelProvider getTransportChannelProvider()
Returns
TypeDescription
TransportChannelProvider

toBuilder()

public abstract StubSettings.Builder toBuilder()
Returns
TypeDescription
Builder

toString()

public String toString()
Returns
TypeDescription
String
Overrides