public abstract static class ClientSettings.Builder<SettingsT,B>
Type Parameters |
|---|
| Name | Description |
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.
Constructors
Builder()
Builder(ClientSettings settings)
protected Builder(ClientSettings settings)
Create a builder from a ClientSettings object.
Builder(StubSettings.Builder stubSettings)
protected Builder(StubSettings.Builder stubSettings)
Create a builder from a StubSettings object.
| Parameter |
|---|
| Name | Description |
stubSettings | Builder
|
Methods
build()
public abstract SettingsT build()
| Returns |
|---|
| Type | Description |
SettingsT | |
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.
getClock()
public ApiClock getClock()
Gets the ApiClock that was previously set on this Builder.
getCredentialsProvider()
public CredentialsProvider getCredentialsProvider()
Gets the CredentialsProvider that was previously set on this Builder.
getEndpoint()
public String getEndpoint()
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.
getGdchApiAudience()
public String getGdchApiAudience()
Gets the GDCH API audience that was previously set in this Builder
public 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.
getQuotaProjectId()
public String getQuotaProjectId()
Gets the QuotaProjectId that was previously set on this Builder.
getStubSettings()
protected StubSettings.Builder getStubSettings()
getTransportChannelProvider()
public TransportChannelProvider getTransportChannelProvider()
Gets the TransportProvider that was previously set on this Builder.
getWatchdogCheckInterval()
public Duration getWatchdogCheckInterval()
| Returns |
|---|
| Type | Description |
org.threeten.bp.Duration | |
getWatchdogProvider()
public WatchdogProvider getWatchdogProvider()
self()
setBackgroundExecutorProvider(ExecutorProvider executorProvider)
public B setBackgroundExecutorProvider(ExecutorProvider executorProvider)
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.
setCredentialsProvider(CredentialsProvider credentialsProvider)
public B setCredentialsProvider(CredentialsProvider credentialsProvider)
Sets the CredentialsProvider to use for getting the credentials to make calls with.
setEndpoint(String endpoint)
public B setEndpoint(String endpoint)
| Parameter |
|---|
| Name | Description |
endpoint | String
|
setExecutorProvider(ExecutorProvider executorProvider) (deprecated)
public B setExecutorProvider(ExecutorProvider executorProvider)
setGdchApiAudience(String gdchApiAudience)
public B setGdchApiAudience(String gdchApiAudience)
Sets the GDC-H api audience. This is intended only to be used with com.google.auth.oauth2.GdchCredentials If this field is set and other type of com.google.auth.Credentials is used then an IllegalArgumentException will be thrown.
If the provided credentials already have an api audience, then it will be overriden by this
audience
| Parameter |
|---|
| Name | Description |
gdchApiAudience | String
|
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.
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.
setQuotaProjectId(String quotaProjectId)
public B setQuotaProjectId(String quotaProjectId)
| Parameter |
|---|
| Name | Description |
quotaProjectId | String
|
setTransportChannelProvider(TransportChannelProvider transportChannelProvider)
public B setTransportChannelProvider(TransportChannelProvider transportChannelProvider)
Sets the TransportProvider to use for getting the transport-specific context to make calls
with.
setWatchdogCheckInterval(Duration checkInterval)
public B setWatchdogCheckInterval(Duration checkInterval)
| Parameter |
|---|
| Name | Description |
checkInterval | org.threeten.bp.Duration
|
setWatchdogProvider(WatchdogProvider watchdogProvider)
public B setWatchdogProvider(WatchdogProvider watchdogProvider)
toString()
Overrides
