public abstract static class StubSettings.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(ClientContext clientContext)
protected Builder(ClientContext clientContext)
Builder(StubSettings settings)
protected Builder(StubSettings settings)
Create a builder from a StubSettings object.
Methods
<B>build()
public abstract StubSettings<B> <B>build()
getBackgroundExecutorProvider()
public ExecutorProvider getBackgroundExecutorProvider()
Gets the ExecutorProvider that was previously set on this Builder.
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()
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.
getMtlsEndpoint()
public String getMtlsEndpoint()
getQuotaProjectId()
public String getQuotaProjectId()
Gets the QuotaProjectId that was previously set on this Builder.
getStreamWatchdogCheckInterval()
public Duration getStreamWatchdogCheckInterval()
| Returns |
|---|
| Type | Description |
org.threeten.bp.Duration | |
getStreamWatchdogProvider()
public WatchdogProvider getStreamWatchdogProvider()
getTracerFactory()
public ApiTracerFactory getTracerFactory()
getTransportChannelProvider()
public TransportChannelProvider getTransportChannelProvider()
Gets the TransportProvider that was previously set on this Builder.
self()
setBackgroundExecutorProvider(ExecutorProvider backgroundExecutorProvider)
public B setBackgroundExecutorProvider(ExecutorProvider backgroundExecutorProvider)
Sets the executor to use for running scheduled API call logic (such as retries and
long-running operations).
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 API audience used by com.google.auth.oauth2.GdchCredentials It cannot be
used if other type of com.google.auth.Credentials is used. If the provided
credentials already have an api audience set, then it will be overriden by this audience
| Parameter |
|---|
| Name | Description |
gdchApiAudience | String
the audience to be used - must be a valid URI 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.
setMtlsEndpoint(String mtlsEndpoint)
public B setMtlsEndpoint(String mtlsEndpoint)
| Parameter |
|---|
| Name | Description |
mtlsEndpoint | String
|
setQuotaProjectId(String quotaProjectId)
public B setQuotaProjectId(String quotaProjectId)
| Parameter |
|---|
| Name | Description |
quotaProjectId | String
|
setStreamWatchdogCheckInterval(Duration checkInterval)
public B setStreamWatchdogCheckInterval(Duration checkInterval)
Sets how often the Watchdog will check ongoing streaming RPCs. Defaults to 10 secs.
Use Duration#ZERO to disable.
| Parameter |
|---|
| Name | Description |
checkInterval | org.threeten.bp.Duration
|
setStreamWatchdogProvider(WatchdogProvider streamWatchdogProvider)
public B setStreamWatchdogProvider(WatchdogProvider streamWatchdogProvider)
setSwitchToMtlsEndpointAllowed(boolean switchToMtlsEndpointAllowed)
protected B setSwitchToMtlsEndpointAllowed(boolean switchToMtlsEndpointAllowed)
| Parameter |
|---|
| Name | Description |
switchToMtlsEndpointAllowed | boolean
|
setTracerFactory(ApiTracerFactory tracerFactory)
public B setTracerFactory(ApiTracerFactory tracerFactory)
setTransportChannelProvider(TransportChannelProvider transportChannelProvider)
public B setTransportChannelProvider(TransportChannelProvider transportChannelProvider)
Sets the TransportProvider to use for getting the transport-specific context to make calls
with.
toString()
Overrides
