com.google.api.gax.rpc

Class StubSettings<SettingsT extends StubSettings<SettingsT>>

java.lang.Object

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

public abstract class StubSettings<SettingsT extends StubSettings<SettingsT>>
extends Object

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.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
String	getApiKey()
ExecutorProvider	getBackgroundExecutorProvider()
com.google.api.core.ApiClock	getClock()
CredentialsProvider	getCredentialsProvider()
String	getEndpoint()
ExecutorProvider	getExecutorProvider() Deprecated. Please use getBackgroundExecutorProvider().
HeaderProvider	getHeaderProvider()
protected HeaderProvider	getInternalHeaderProvider()
String	getMtlsEndpoint()
String	getQuotaProjectId()
org.threeten.bp.Duration	getStreamWatchdogCheckInterval()
WatchdogProvider	getStreamWatchdogProvider()
ApiTracerFactory	getTracerFactory() Gets the configured ApiTracerFactory that will be used to generate traces for operations.
TransportChannelProvider	getTransportChannelProvider()
abstract StubSettings.Builder	toBuilder()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

StubSettings

protected StubSettings(StubSettings.Builder builder)

Constructs an instance of StubSettings.

Method Detail

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

@BetaApi(value="The surface for customizing headers is not stable yet and may change in the future.")
public final HeaderProvider getHeaderProvider()

getInternalHeaderProvider

@BetaApi(value="The surface for customizing headers is not stable yet and may change in the future.")
protected final HeaderProvider getInternalHeaderProvider()

getClock

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

getEndpoint

public final String getEndpoint()

getMtlsEndpoint

public final String getMtlsEndpoint()

getQuotaProjectId

public final String getQuotaProjectId()

getApiKey

public final String getApiKey()

getStreamWatchdogProvider

@BetaApi(value="The surface for streaming is not stable yet and may change in the future.")
 @Nullable
public final WatchdogProvider getStreamWatchdogProvider()

getStreamWatchdogCheckInterval

@BetaApi(value="The surface for streaming is not stable yet and may change in the future.")
 @Nonnull
public final org.threeten.bp.Duration getStreamWatchdogCheckInterval()

getTracerFactory

@BetaApi(value="The surface for tracing is not stable yet and may change in the future.")
 @Nonnull
public ApiTracerFactory getTracerFactory()

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

toString

public String toString()

Overrides:

toString in class Object

toBuilder

public abstract StubSettings.Builder toBuilder()