com.google.api.gax.rpc

Class ClientSettings<SettingsT extends ClientSettings<SettingsT>>

java.lang.Object

com.google.api.gax.rpc.ClientSettings<SettingsT>

@BetaApi
public abstract class ClientSettings<SettingsT extends ClientSettings<SettingsT>>
extends Object

A base settings class to configure a service API 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.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ClientSettings.Builder<SettingsT extends ClientSettings<SettingsT>,B extends ClientSettings.Builder<SettingsT,B>>

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ClientSettings(ClientSettings.Builder builder) Constructs an instance of ClientSettings.
protected	ClientSettings(ExecutorProvider executorProvider, TransportChannelProvider transportChannelProvider, CredentialsProvider credentialsProvider, HeaderProvider headerProvider, com.google.api.core.ApiClock clock) Deprecated. Use ClientSettings(Builder) instead

Method Summary

Modifier and Type	Method and Description
com.google.api.core.ApiClock	getClock()
CredentialsProvider	getCredentialsProvider()
String	getEndpoint()
ExecutorProvider	getExecutorProvider()
HeaderProvider	getHeaderProvider()
TransportChannelProvider	getTransportChannelProvider()
abstract <B extends ClientSettings.Builder<SettingsT,B>> B	toBuilder()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ClientSettings

@Deprecated
protected ClientSettings(ExecutorProvider executorProvider,
                                     TransportChannelProvider transportChannelProvider,
                                     CredentialsProvider credentialsProvider,
                                     HeaderProvider headerProvider,
                                     com.google.api.core.ApiClock clock)

Deprecated. Use ClientSettings(Builder) instead

Constructs an instance of ClientSettings.

ClientSettings

protected ClientSettings(ClientSettings.Builder builder)

Constructs an instance of ClientSettings.

Method Detail

getExecutorProvider

public final ExecutorProvider getExecutorProvider()

getTransportChannelProvider

public final TransportChannelProvider getTransportChannelProvider()

getCredentialsProvider

public final CredentialsProvider getCredentialsProvider()

getHeaderProvider

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

getClock

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

getEndpoint

public final String getEndpoint()

toString

public String toString()

Overrides:

toString in class Object

toBuilder

public abstract <B extends ClientSettings.Builder<SettingsT,B>> B toBuilder()