Class StubSettings<SettingsT> (2.55.0)

Version 2.55.0

• 2.58.0 (latest)
• 2.57.0
• 2.55.0
• 2.54.1
• 2.53.0
• 2.52.0
• 2.51.0
• 2.50.0
• 2.49.0
• 2.48.1
• 2.47.0
• 2.46.1
• 2.45.0
• 2.43.0
• 2.42.0
• 2.41.0
• 2.39.0
• 2.38.0
• 2.37.0
• 2.36.0
• 2.35.0
• 2.34.1
• 2.33.0
• 2.32.1
• 2.31.1
• 2.30.1
• 2.24.0
• 2.23.3
• 2.22.0
• 2.21.0
• 2.20.1
• 2.19.6
• 2.18.7
• 2.17.0
• 2.16.0
• 2.15.0
• 2.14.0
• 2.13.0
• 2.12.2
• 2.11.0
• 2.10.0
• 2.9.0
• 2.8.1
• 2.7.1

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>

Inherited Members

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.toString()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Type Parameter
Name	Description
SettingsT

Constructors

StubSettings(StubSettings.Builder builder)

protected StubSettings(StubSettings.Builder builder)

Constructs an instance of StubSettings.

Parameter
Name	Description
builder	Builder

Methods

getApiKey()

public final String getApiKey()

Gets the API Key that should be used for authentication.

Returns
Type	Description
String

getBackgroundExecutorProvider()

public final ExecutorProvider getBackgroundExecutorProvider()

Returns
Type	Description
ExecutorProvider

getClock()

public final ApiClock getClock()

Returns
Type	Description
ApiClock

getCredentialsProvider()

public final CredentialsProvider getCredentialsProvider()

Returns
Type	Description
CredentialsProvider

getEndpoint()

public String getEndpoint()

Returns
Type	Description
String	the fully resolved endpoint used by the client

getExecutorProvider() (deprecated)

public final ExecutorProvider getExecutorProvider()

Deprecated. Please use #getBackgroundExecutorProvider().

Returns
Type	Description
ExecutorProvider

getGdchApiAudience()

public final String getGdchApiAudience()

Gets the GDCH API audience to be used with com.google.auth.oauth2.GdchCredentials

Returns
Type	Description
String

getHeaderProvider()

public final HeaderProvider getHeaderProvider()

Returns
Type	Description
HeaderProvider

getInternalHeaderProvider()

protected final HeaderProvider getInternalHeaderProvider()

Returns
Type	Description
HeaderProvider

getMtlsEndpoint()

public final String getMtlsEndpoint()

Returns
Type	Description
String

getQuotaProjectId()

public final String getQuotaProjectId()

Returns
Type	Description
String

getServiceName()

protected String getServiceName()

Internal Only: This feature is not stable for application use.

Marked with Internal Api and meant to overriden by the generated subclasses. This getter is used to set the serviceName to the EndpointContext. The value in generated StubSettings subclasses comes from the proto files.

This should be effectively treated as an abstract method.

Returns
Type	Description
String

getStreamWatchdogCheckInterval()

public final Duration getStreamWatchdogCheckInterval()

Obsolete

Use getStreamWatchdogCheckIntervalDuration() instead

This feature is stable for usage in this major version, but may be deprecated in a future release.

This method is obsolete. Use #getStreamWatchdogCheckIntervalDuration() instead.

Returns
Type	Description
org.threeten.bp.Duration

getStreamWatchdogCheckIntervalDuration()

public final Duration getStreamWatchdogCheckIntervalDuration()

Returns
Type	Description
Duration

getStreamWatchdogProvider()

public final WatchdogProvider getStreamWatchdogProvider()

Returns
Type	Description
WatchdogProvider

getTracerFactory()

public ApiTracerFactory getTracerFactory()

Beta

The surface for tracing is not stable yet and may change in the future.

This feature is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

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

Returns
Type	Description
ApiTracerFactory

getTransportChannelProvider()

public final TransportChannelProvider getTransportChannelProvider()

Returns
Type	Description
TransportChannelProvider

getUniverseDomain()

public final String getUniverseDomain()

Returns
Type	Description
String	the fully resolved universe domain used by the client

toBuilder()

public abstract StubSettings.Builder toBuilder()

Returns
Type	Description
Builder

toString()

public String toString()

Returns
Type	Description
String

Overrides

Object.toString()