Package 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	Description
static class	StubSettings.Builder<SettingsT extends StubSettings<SettingsT>,B extends StubSettings.Builder<SettingsT,B>>

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
final ExecutorProvider	getBackgroundExecutorProvider()
final ApiClock	getClock()
final CredentialsProvider	getCredentialsProvider()
String	getEndpoint()
final ExecutorProvider	getExecutorProvider()	Deprecated. Please use getBackgroundExecutorProvider().
final String	getGdchApiAudience()	Gets the GDCH API audience to be used with GdchCredentials
final HeaderProvider	getHeaderProvider()
protected final HeaderProvider	getInternalHeaderProvider()
final String	getMtlsEndpoint()
final String	getQuotaProjectId()
String	getServiceName()
final org.threeten.bp.Duration	getStreamWatchdogCheckInterval()
final WatchdogProvider	getStreamWatchdogProvider()
ApiTracerFactory	getTracerFactory()	Gets the configured ApiTracerFactory that will be used to generate traces for operations.
final TransportChannelProvider	getTransportChannelProvider()
final String	getUniverseDomain()
abstract StubSettings.Builder	toBuilder()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

StubSettings

protected StubSettings(StubSettings.Builder builder)

Constructs an instance of StubSettings.

Method Details

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()

getServiceName

@InternalApi
public String getServiceName()

getUniverseDomain

public final String getUniverseDomain()

getEndpoint

public String getEndpoint()

getMtlsEndpoint

public final String getMtlsEndpoint()

getQuotaProjectId

public final String getQuotaProjectId()

getStreamWatchdogProvider

@Nullable
public final WatchdogProvider getStreamWatchdogProvider()

getStreamWatchdogCheckInterval

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

getTracerFactory

@BetaApi("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.

getGdchApiAudience

@Nullable
public final String getGdchApiAudience()

Gets the GDCH API audience to be used with GdchCredentials

toString

public String toString()

Overrides:

toString in class Object

toBuilder

public abstract StubSettings.Builder toBuilder()