com.google.api.gax.rpc

Class ClientSettings.Builder<SettingsT extends ClientSettings<SettingsT>,B extends ClientSettings.Builder<SettingsT,B>>

java.lang.Object

com.google.api.gax.rpc.ClientSettings.Builder<SettingsT,B>

Enclosing class:

ClientSettings<SettingsT extends ClientSettings<SettingsT>>

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

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Builder()
protected	Builder(ClientSettings settings) Create a builder from a ClientSettings object.
protected	Builder(StubSettings.Builder stubSettings) Create a builder from a StubSettings object.

Method Summary

Modifier and Type	Method and Description
protected static void	applyToAllUnaryMethods(Iterable<UnaryCallSettings.Builder<?,?>> methodSettingsBuilders, com.google.api.core.ApiFunction<UnaryCallSettings.Builder<?,?>,Void> settingsUpdater) Applies the given settings updater function to the given method settings builders.
abstract SettingsT	build()
com.google.api.core.ApiClock	getClock() Gets the ApiClock that was previously set on this Builder.
CredentialsProvider	getCredentialsProvider() Gets the CredentialsProvider that was previously set on this Builder.
String	getEndpoint()
ExecutorProvider	getExecutorProvider() Gets the ExecutorProvider that was previously set on this Builder.
HeaderProvider	getHeaderProvider() Gets the custom HeaderProvider that was previously set on this Builder.
protected HeaderProvider	getInternalHeaderProvider() Gets the internal HeaderProvider that was previously set on this Builder.
protected StubSettings.Builder	getStubSettings()
TransportChannelProvider	getTransportChannelProvider() Gets the TransportProvider that was previously set on this Builder.
org.threeten.bp.Duration	getWatchdogCheckInterval()
WatchdogProvider	getWatchdogProvider()
protected B	self()
B	setClock(com.google.api.core.ApiClock clock) Sets the clock to use for retry logic.
B	setCredentialsProvider(CredentialsProvider credentialsProvider) Sets the CredentialsProvider to use for getting the credentials to make calls with.
B	setEndpoint(String endpoint)
B	setExecutorProvider(ExecutorProvider executorProvider) 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.
B	setHeaderProvider(HeaderProvider headerProvider) Sets the HeaderProvider for getting custom static headers for http requests.
protected B	setInternalHeaderProvider(HeaderProvider internalHeaderProvider) Sets the HeaderProvider for getting internal (library-defined) static headers for http requests.
B	setTransportChannelProvider(TransportChannelProvider transportChannelProvider) Sets the TransportProvider to use for getting the transport-specific context to make calls with.
B	setWatchdogCheckInterval(org.threeten.bp.Duration checkInterval)
B	setWatchdogProvider(WatchdogProvider watchdogProvider)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

protected Builder(ClientSettings settings)

Create a builder from a ClientSettings object.

Builder

protected Builder(StubSettings.Builder stubSettings)

Create a builder from a StubSettings object.

Builder

protected Builder()

Method Detail

self

protected B self()

getStubSettings

protected StubSettings.Builder getStubSettings()

setExecutorProvider

public B setExecutorProvider(ExecutorProvider executorProvider)

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.

setCredentialsProvider

public B setCredentialsProvider(CredentialsProvider credentialsProvider)

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

setHeaderProvider

@BetaApi(value="The surface for customizing headers is not stable yet and may change in the future.")
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.

setInternalHeaderProvider

@BetaApi(value="The surface for customizing headers is not stable yet and may change in the future.")
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.

setTransportChannelProvider

public B setTransportChannelProvider(TransportChannelProvider transportChannelProvider)

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

setClock

public B setClock(com.google.api.core.ApiClock clock)

Sets the clock to use for retry logic.

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

setEndpoint

public B setEndpoint(String endpoint)

setWatchdogProvider

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

setWatchdogCheckInterval

@BetaApi(value="The surface for streaming is not stable yet and may change in the future.")
public B setWatchdogCheckInterval(@Nullable
                                                                                                                              org.threeten.bp.Duration checkInterval)

getExecutorProvider

public ExecutorProvider getExecutorProvider()

Gets the ExecutorProvider that was previously set on this Builder.

getTransportChannelProvider

public TransportChannelProvider getTransportChannelProvider()

Gets the TransportProvider that was previously set on this Builder.

getCredentialsProvider

public CredentialsProvider getCredentialsProvider()

Gets the CredentialsProvider that was previously set on this Builder.

getHeaderProvider

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

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

getInternalHeaderProvider

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

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

getClock

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

Gets the ApiClock that was previously set on this Builder.

getEndpoint

public String getEndpoint()

getWatchdogProvider

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

getWatchdogCheckInterval

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

applyToAllUnaryMethods

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

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

build

public abstract SettingsT build()
                         throws IOException

Throws:

IOException

toString

public String toString()

Overrides:

toString in class Object