Class StubSettings<SettingsT> (2.50.0)

publicabstractclassStubSettings<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.wait(long,int)

Type Parameter
Name	Description
`SettingsT`

Constructors

StubSettings(StubSettings.Builder builder)

protectedStubSettings(StubSettings.Builderbuilder)

Constructs an instance of StubSettings.

Parameter
Name	Description
`builder`	`Builder`

Methods

getBackgroundExecutorProvider()

publicfinalExecutorProvidergetBackgroundExecutorProvider()

Returns
Type	Description
`ExecutorProvider`

getClock()

publicfinalApiClockgetClock()

Returns
Type	Description
`ApiClock`

getCredentialsProvider()

publicfinalCredentialsProvidergetCredentialsProvider()

Returns
Type	Description
`CredentialsProvider`

getEndpoint()

publicStringgetEndpoint()

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

getExecutorProvider() (deprecated)

publicfinalExecutorProvidergetExecutorProvider()

Deprecated.Please use#getBackgroundExecutorProvider().

Returns
Type	Description
`ExecutorProvider`

getGdchApiAudience()

publicfinalStringgetGdchApiAudience()

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

Returns
Type	Description
`String`

getHeaderProvider()

publicfinalHeaderProvidergetHeaderProvider()

Returns
Type	Description
`HeaderProvider`

getInternalHeaderProvider()

protectedfinalHeaderProvidergetInternalHeaderProvider()

Returns
Type	Description
`HeaderProvider`

getMtlsEndpoint()

publicfinalStringgetMtlsEndpoint()

Returns
Type	Description
`String`

getQuotaProjectId()

publicfinalStringgetQuotaProjectId()

Returns
Type	Description
`String`

getServiceName()

protectedStringgetServiceName()

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

publicfinalDurationgetStreamWatchdogCheckInterval()

Returns
Type	Description
`org.threeten.bp.Duration`

getStreamWatchdogProvider()

publicfinalWatchdogProvidergetStreamWatchdogProvider()

Returns
Type	Description
`WatchdogProvider`

getTracerFactory()

publicApiTracerFactorygetTracerFactory()

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 configuredApiTracerFactory that will be used to generate traces for operations.

Returns
Type	Description
`ApiTracerFactory`

getTransportChannelProvider()

publicfinalTransportChannelProvidergetTransportChannelProvider()

Returns
Type	Description
`TransportChannelProvider`

getUniverseDomain()

publicfinalStringgetUniverseDomain()

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

toBuilder()

publicabstractStubSettings.BuildertoBuilder()

Returns
Type	Description
`Builder`

toString()

publicStringtoString()

Returns
Type	Description
`String`

Overrides