Class ClientSettings<SettingsT> (2.65.0)

  public 
  
 abstract 
  
 class 
 ClientSettings<SettingsT> 
 

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

Inheritance

java.lang.Object > ClientSettings<SettingsT>

Type Parameter

Name
Description
SettingsT

Constructors

ClientSettings(ClientSettings.Builder builder)

  protected 
  
 ClientSettings 
 ( 
 ClientSettings 
 . 
 Builder 
  
 builder 
 ) 
 

Constructs an instance of ClientSettings.

Parameter
Name
Description
builder

Methods

<B>toBuilder()

  public 
  
 abstract 
  
 B 
  
< B>toBuilder 
 () 
 
Returns
Type
Description
B

getApiKey()

  public 
  
 final 
  
 String 
  
 getApiKey 
 () 
 

Gets the API Key that should be used for authentication.

Returns
Type
Description

getBackgroundExecutorProvider()

  public 
  
 final 
  
 ExecutorProvider 
  
 getBackgroundExecutorProvider 
 () 
 
Returns
Type
Description

getClock()

  public 
  
 final 
  
 ApiClock 
  
 getClock 
 () 
 
Returns
Type
Description

getCredentialsProvider()

  public 
  
 final 
  
 CredentialsProvider 
  
 getCredentialsProvider 
 () 
 
Returns
Type
Description

getEndpoint()

  public 
  
 final 
  
 String 
  
 getEndpoint 
 () 
 
Returns
Type
Description

getExecutorProvider() (deprecated)

  public 
  
 final 
  
 ExecutorProvider 
  
 getExecutorProvider 
 () 
 

Deprecated. Please use #getBackgroundExecutorProvider()

Returns
Type
Description

getGdchApiAudience()

  public 
  
 final 
  
 String 
  
 getGdchApiAudience 
 () 
 

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

Returns
Type
Description

getHeaderProvider()

  public 
  
 final 
  
 HeaderProvider 
  
 getHeaderProvider 
 () 
 
Returns
Type
Description

getInternalHeaderProvider()

  protected 
  
 final 
  
 HeaderProvider 
  
 getInternalHeaderProvider 
 () 
 
Returns
Type
Description

getQuotaProjectId()

  public 
  
 final 
  
 String 
  
 getQuotaProjectId 
 () 
 
Returns
Type
Description

getStubSettings()

  public 
  
 final 
  
 StubSettings 
  
 getStubSettings 
 () 
 
Returns
Type
Description

getTransportChannelProvider()

  public 
  
 final 
  
 TransportChannelProvider 
  
 getTransportChannelProvider 
 () 
 
Returns
Type
Description

getUniverseDomain()

  public 
  
 final 
  
 String 
  
 getUniverseDomain 
 () 
 
Returns
Type
Description

getWatchdogCheckInterval()

  public 
  
 final 
  
 Duration 
  
 getWatchdogCheckInterval 
 () 
 

This method is obsolete. Use #getWatchdogCheckIntervalDuration() instead.

Returns
Type
Description
org.threeten.bp.Duration

getWatchdogCheckIntervalDuration()

  public 
  
 final 
  
 Duration 
  
 getWatchdogCheckIntervalDuration 
 () 
 
Returns
Type
Description

getWatchdogProvider()

  public 
  
 final 
  
 WatchdogProvider 
  
 getWatchdogProvider 
 () 
 
Returns
Type
Description

toString()

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