Class ClientSettings.Builder<SettingsT,B>

public abstract static class ClientSettings.Builder<SettingsT,B>

Inheritance

java.lang.Object > ClientSettings.Builder<SettingsT,B>

Type Parameters

NameDescription
SettingsT
B

Static Methods

applyToAllUnaryMethods(Iterable<UnaryCallSettings.Builder<?,?>> methodSettingsBuilders, ApiFunction<UnaryCallSettings.Builder<?,?>,Void> settingsUpdater)

protected static void applyToAllUnaryMethods(Iterable<UnaryCallSettings.Builder<?,?>> methodSettingsBuilders, ApiFunction<UnaryCallSettings.Builder<?,?>,Void> settingsUpdater)

Applies the given settings updater function to the given method settings builders.

Parameters
NameDescription
methodSettingsBuildersIterable<Builder<?,?>>
settingsUpdatercom.google.api.core.ApiFunction<Builder<?,?>,Void>

Constructors

Builder()

protected Builder()

Builder(ClientSettings settings)

protected Builder(ClientSettings settings)

Create a builder from a ClientSettings object.

Parameter
NameDescription
settingsClientSettings

Builder(StubSettings.Builder stubSettings)

protected Builder(StubSettings.Builder stubSettings)

Create a builder from a StubSettings object.

Parameter
NameDescription
stubSettingsBuilder

Methods

build()

public abstract SettingsT build()
Returns
TypeDescription
SettingsT
Exceptions
TypeDescription
IOException

getBackgroundExecutorProvider()

public ExecutorProvider getBackgroundExecutorProvider()

Gets the ExecutorProvider that was previously set on this Builder. This ExecutorProvider is to use for running asynchronous API call logic (such as retries and long-running operations). This ExecutorProvider is not used to set the executor in TransportChannelProvider.

Returns
TypeDescription
ExecutorProvider

getClock()

public ApiClock getClock()

Gets the ApiClock that was previously set on this Builder.

Returns
TypeDescription
com.google.api.core.ApiClock

getCredentialsProvider()

public CredentialsProvider getCredentialsProvider()

Gets the CredentialsProvider that was previously set on this Builder.

Returns
TypeDescription
CredentialsProvider

getEndpoint()

public String getEndpoint()
Returns
TypeDescription
String

getExecutorProvider() (deprecated)

public ExecutorProvider getExecutorProvider()

Deprecated. Please use #getBackgroundExecutorProvider() for getting the executor provider that's used for running scheduled API call logic.

Gets the ExecutorProvider that was previously set on this Builder. This ExecutorProvider is to use for running asynchronous API call logic (such as retries and long-running operations), and also to pass to the transport settings if an executor is needed for the transport and it doesn't have its own executor provider.

Returns
TypeDescription
ExecutorProvider

getHeaderProvider()

public HeaderProvider getHeaderProvider()

Gets the custom HeaderProvider that was previously set on this Builder.

Returns
TypeDescription
HeaderProvider

getInternalHeaderProvider()

protected HeaderProvider getInternalHeaderProvider()

Gets the internal HeaderProvider that was previously set on this Builder.

Returns
TypeDescription
HeaderProvider

getQuotaProjectId()

public String getQuotaProjectId()

Gets the QuotaProjectId that was previously set on this Builder.

Returns
TypeDescription
String

getStubSettings()

protected StubSettings.Builder getStubSettings()
Returns
TypeDescription
Builder

getTransportChannelProvider()

public TransportChannelProvider getTransportChannelProvider()

Gets the TransportProvider that was previously set on this Builder.

Returns
TypeDescription
TransportChannelProvider

getWatchdogCheckInterval()

public Duration getWatchdogCheckInterval()
Returns
TypeDescription
org.threeten.bp.Duration

getWatchdogProvider()

public WatchdogProvider getWatchdogProvider()
Returns
TypeDescription
WatchdogProvider

self()

protected B self()
Returns
TypeDescription
B

setBackgroundExecutorProvider(ExecutorProvider executorProvider)

public B setBackgroundExecutorProvider(ExecutorProvider executorProvider)

Sets the ExecutorProvider to use for getting the executor to use for running scheduled API call logic (such as retries and long-running operations). This will not set the executor in TransportChannelProvider. To set executor for TransportChannelProvider, please use TransportChannelProvider#withExecutor(Executor).

Parameter
NameDescription
executorProviderExecutorProvider
Returns
TypeDescription
B

setClock(ApiClock clock)

public B setClock(ApiClock clock)

Sets the clock to use for retry logic.

This will default to a system clock if it is not set.

Parameter
NameDescription
clockcom.google.api.core.ApiClock
Returns
TypeDescription
B

setCredentialsProvider(CredentialsProvider credentialsProvider)

public B setCredentialsProvider(CredentialsProvider credentialsProvider)

Sets the CredentialsProvider to use for getting the credentials to make calls with.

Parameter
NameDescription
credentialsProviderCredentialsProvider
Returns
TypeDescription
B

setEndpoint(String endpoint)

public B setEndpoint(String endpoint)
Parameter
NameDescription
endpointString
Returns
TypeDescription
B

setExecutorProvider(ExecutorProvider executorProvider) (deprecated)

public B setExecutorProvider(ExecutorProvider executorProvider)

Deprecated. Please use #setBackgroundExecutorProvider(ExecutorProvider) for setting executor to use for running scheduled API call logic. To set executor for TransportChannelProvider, please use TransportChannelProvider#withExecutor(Executor) instead.

Sets the ExecutorProvider to use for getting the executor to use for running asynchronous API call logic (such as retries and long-running operations), and also to pass to the transport settings if an executor is needed for the transport and it doesn't have its own executor provider.

Parameter
NameDescription
executorProviderExecutorProvider
Returns
TypeDescription
B

setHeaderProvider(HeaderProvider headerProvider)

public B setHeaderProvider(HeaderProvider headerProvider)

Sets the HeaderProvider for getting custom static headers for http requests. The header provider will be called during client construction only once. The headers returned by the provider will be cached and supplied as is for each request issued by the constructed client. Some reserved headers can be overridden (e.g. Content-Type) or merged with the default value (e.g. User-Agent) by the underlying transport layer.

Parameter
NameDescription
headerProviderHeaderProvider
Returns
TypeDescription
B

setInternalHeaderProvider(HeaderProvider internalHeaderProvider)

protected B setInternalHeaderProvider(HeaderProvider internalHeaderProvider)

Sets the HeaderProvider for getting internal (library-defined) static headers for http requests. The header provider will be called during client construction only once. The headers returned by the provider will be cached and supplied as is for each request issued by the constructed client. Some reserved headers can be overridden (e.g. Content-Type) or merged with the default value (e.g. User-Agent) by the underlying transport layer.

Parameter
NameDescription
internalHeaderProviderHeaderProvider
Returns
TypeDescription
B

setQuotaProjectId(String quotaProjectId)

public B setQuotaProjectId(String quotaProjectId)
Parameter
NameDescription
quotaProjectIdString
Returns
TypeDescription
B

setTransportChannelProvider(TransportChannelProvider transportChannelProvider)

public B setTransportChannelProvider(TransportChannelProvider transportChannelProvider)

Sets the TransportProvider to use for getting the transport-specific context to make calls with.

Parameter
NameDescription
transportChannelProviderTransportChannelProvider
Returns
TypeDescription
B

setWatchdogCheckInterval(Duration checkInterval)

public B setWatchdogCheckInterval(Duration checkInterval)
Parameter
NameDescription
checkIntervalorg.threeten.bp.Duration
Returns
TypeDescription
B

setWatchdogProvider(WatchdogProvider watchdogProvider)

public B setWatchdogProvider(WatchdogProvider watchdogProvider)
Parameter
NameDescription
watchdogProviderWatchdogProvider
Returns
TypeDescription
B

toString()

public String toString()
Returns
TypeDescription
String
Overrides