Class StubSettings.Builder<SettingsT,B> (2.47.0)

  public 
  
 abstract 
  
 static 
  
 class 
 StubSettings 
 . 
 Builder<SettingsT 
 , 
 B 
> 

Inheritance

java.lang.Object > 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.

Parameters
Name
Description
methodSettingsBuilders
Iterable < Builder < ? , ? >>
settingsUpdater
ApiFunction < Builder < ? , ? >, Void >

Constructors

Builder()

  protected 
  
 Builder 
 () 
 

Builder(ClientContext clientContext)

  protected 
  
 Builder 
 ( 
 ClientContext 
  
 clientContext 
 ) 
 
Parameter
Name
Description
clientContext

Builder(StubSettings settings)

  protected 
  
 Builder 
 ( 
 StubSettings 
  
 settings 
 ) 
 

Create a builder from a StubSettings object.

Parameter
Name
Description
settings

Methods

<B>build()

  public 
  
 abstract 
  
 StubSettings<B> 
  
< B>build 
 () 
 
Returns
Type
Description
StubSettings < B >
Exceptions
Type
Description

getBackgroundExecutorProvider()

  public 
  
 ExecutorProvider 
  
 getBackgroundExecutorProvider 
 () 
 

Gets the ExecutorProvider that was previously set on this Builder.

Returns
Type
Description

getClock()

  public 
  
 ApiClock 
  
 getClock 
 () 
 

Gets the ApiClock that was previously set on this Builder.

Returns
Type
Description

getCredentialsProvider()

  public 
  
 CredentialsProvider 
  
 getCredentialsProvider 
 () 
 

Gets the CredentialsProvider that was previously set on this Builder.

Returns
Type
Description

getEndpoint()

  public 
  
 String 
  
 getEndpoint 
 () 
 
Returns
Type
Description

getExecutorProvider() (deprecated)

  public 
  
 ExecutorProvider 
  
 getExecutorProvider 
 () 
 

Deprecated. Please use #getBackgroundExecutorProvider() .

Returns
Type
Description

getGdchApiAudience()

  public 
  
 String 
  
 getGdchApiAudience 
 () 
 

Gets the GDCH API audience that was previously set in this Builder

Returns
Type
Description

getHeaderProvider()

  public 
  
 HeaderProvider 
  
 getHeaderProvider 
 () 
 

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

Returns
Type
Description

getInternalHeaderProvider()

  protected 
  
 HeaderProvider 
  
 getInternalHeaderProvider 
 () 
 

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

Returns
Type
Description

getMtlsEndpoint()

  public 
  
 String 
  
 getMtlsEndpoint 
 () 
 
Returns
Type
Description

getQuotaProjectId()

  public 
  
 String 
  
 getQuotaProjectId 
 () 
 

Gets the QuotaProjectId that was previously set on this Builder.

Returns
Type
Description

getStreamWatchdogCheckInterval()

  public 
  
 Duration 
  
 getStreamWatchdogCheckInterval 
 () 
 
Returns
Type
Description
org.threeten.bp.Duration

getStreamWatchdogProvider()

  public 
  
 WatchdogProvider 
  
 getStreamWatchdogProvider 
 () 
 

Gets the WatchdogProvider that was previously set on this Builder.

Returns
Type
Description

getTracerFactory()

  public 
  
 ApiTracerFactory 
  
 getTracerFactory 
 () 
 
Returns
Type
Description

getTransportChannelProvider()

  public 
  
 TransportChannelProvider 
  
 getTransportChannelProvider 
 () 
 

Gets the TransportProvider that was previously set on this Builder.

Returns
Type
Description

self()

  protected 
  
 B 
  
 self 
 () 
 
Returns
Type
Description
B

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).

Parameter
Name
Description
backgroundExecutorProvider
Returns
Type
Description
B

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.

Parameter
Name
Description
clock
Returns
Type
Description
B

setCredentialsProvider(CredentialsProvider credentialsProvider)

  public 
  
 B 
  
 setCredentialsProvider 
 ( 
 CredentialsProvider 
  
 credentialsProvider 
 ) 
 

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

Parameter
Name
Description
credentialsProvider
Returns
Type
Description
B

setEndpoint(String endpoint)

  public 
  
 B 
  
 setEndpoint 
 ( 
 String 
  
 endpoint 
 ) 
 
Parameter
Name
Description
endpoint
Returns
Type
Description
B

setExecutorProvider(ExecutorProvider executorProvider) (deprecated)

  public 
  
 B 
  
 setExecutorProvider 
 ( 
 ExecutorProvider 
  
 executorProvider 
 ) 
 

Deprecated. Please use #setBackgroundExecutorProvider(ExecutorProvider) for setting executor to use for running scheduled API call logic. To set executor for TransportChannelProvider , please use TransportChannelProvider#withExecutor(Executor) instead.

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.

Parameter
Name
Description
executorProvider
Returns
Type
Description
B

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

Returns
Type
Description
B

setHeaderProvider(HeaderProvider headerProvider)

  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.

Parameter
Name
Description
headerProvider
Returns
Type
Description
B

setInternalHeaderProvider(HeaderProvider internalHeaderProvider)

  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.

Parameter
Name
Description
internalHeaderProvider
Returns
Type
Description
B

setMtlsEndpoint(String mtlsEndpoint)

  public 
  
 B 
  
 setMtlsEndpoint 
 ( 
 String 
  
 mtlsEndpoint 
 ) 
 
Parameter
Name
Description
mtlsEndpoint
Returns
Type
Description
B

setQuotaProjectId(String quotaProjectId)

  public 
  
 B 
  
 setQuotaProjectId 
 ( 
 String 
  
 quotaProjectId 
 ) 
 
Parameter
Name
Description
quotaProjectId
Returns
Type
Description
B

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
Returns
Type
Description
B

setStreamWatchdogProvider(WatchdogProvider streamWatchdogProvider)

  public 
  
 B 
  
 setStreamWatchdogProvider 
 ( 
 WatchdogProvider 
  
 streamWatchdogProvider 
 ) 
 

Sets the WatchdogProvider to use for streaming RPC.

This will default to a InstantiatingWatchdogProvider if it is not set.

Parameter
Name
Description
streamWatchdogProvider
Returns
Type
Description
B

setSwitchToMtlsEndpointAllowed(boolean switchToMtlsEndpointAllowed)

  protected 
  
 B 
  
 setSwitchToMtlsEndpointAllowed 
 ( 
 boolean 
  
 switchToMtlsEndpointAllowed 
 ) 
 
Parameter
Name
Description
switchToMtlsEndpointAllowed
Returns
Type
Description
B

setTracerFactory(ApiTracerFactory tracerFactory)

  public 
  
 B 
  
 setTracerFactory 
 ( 
 ApiTracerFactory 
  
 tracerFactory 
 ) 
 

Configures the ApiTracerFactory that will be used to generate traces.

Parameter
Name
Description
tracerFactory
ApiTracerFactory

an instance of ApiTracerFactory to set.

Returns
Type
Description
B

setTransportChannelProvider(TransportChannelProvider transportChannelProvider)

  public 
  
 B 
  
 setTransportChannelProvider 
 ( 
 TransportChannelProvider 
  
 transportChannelProvider 
 ) 
 

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

Parameter
Name
Description
transportChannelProvider
Returns
Type
Description
B

setUniverseDomain(String universeDomain)

  public 
  
 B 
  
 setUniverseDomain 
 ( 
 String 
  
 universeDomain 
 ) 
 
Parameter
Name
Description
universeDomain
Returns
Type
Description
B

toString()

  public 
  
 String 
  
 toString 
 () 
 
Returns
Type
Description
Overrides
Design a Mobile Site
View Site in Mobile | Classic
Share by: