com.google.api.gax.rpc

Class ClientSettings.Builder

java.lang.Object

com.google.api.gax.rpc.ClientSettings.Builder

Direct Known Subclasses:

FakeClientSettings.Builder

Enclosing class:

ClientSettings

public abstract static class ClientSettings.Builder
extends Object

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
protected ClientSettings.Builder	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 ClientSettings	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.
ExecutorProvider	getExecutorProvider() Gets the ExecutorProvider that was previously set on this Builder.
TransportProvider	getTransportProvider() Gets the TransportProvider that was previously set on this Builder.
ClientSettings.Builder	setClock(com.google.api.core.ApiClock clock) Sets the clock to use for retry logic.
ClientSettings.Builder	setCredentialsProvider(CredentialsProvider credentialsProvider) Sets the CredentialsProvider to use for getting the credentials to make calls with.
ClientSettings.Builder	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.
ClientSettings.Builder	setTransportProvider(TransportProvider transportProvider) Sets the TransportProvider to use for getting the transport-specific context to make calls with.
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(ClientContext clientContext)

Builder

protected Builder()

Method Detail

setExecutorProvider

public ClientSettings.Builder 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 ClientSettings.Builder setCredentialsProvider(CredentialsProvider credentialsProvider)

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

setTransportProvider

public ClientSettings.Builder setTransportProvider(TransportProvider transportProvider)

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

setClock

public ClientSettings.Builder 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.

getExecutorProvider

public ExecutorProvider getExecutorProvider()

Gets the ExecutorProvider that was previously set on this Builder.

getTransportProvider

public TransportProvider getTransportProvider()

Gets the TransportProvider that was previously set on this Builder.

getCredentialsProvider

public CredentialsProvider getCredentialsProvider()

Gets the CredentialsProvider 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.

applyToAllUnaryMethods

protected ClientSettings.Builder applyToAllUnaryMethods(Iterable<UnaryCallSettings.Builder> methodSettingsBuilders,
                                                        com.google.api.core.ApiFunction<UnaryCallSettings.Builder,Void> settingsUpdater)
                                                 throws Exception

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

Throws:

Exception

build

public abstract ClientSettings build()
                              throws IOException

Throws:

IOException

toString

public String toString()

Overrides:

toString in class Object