Class ServiceOptions.Builder<ServiceT,OptionsT,B> (2.42.0) 

public abstract static class ServiceOptions.Builder<ServiceT,OptionsT,B>

Builder for ServiceOptions.

Inheritance

java.lang.Object > ServiceOptions.Builder<ServiceT,OptionsT,B>

Type Parameters
Name Description
ServiceT
OptionsT
B

Constructors

Builder()

protected Builder()

Builder(ServiceOptions<ServiceT,OptionsT> options)

protected Builder(ServiceOptions<ServiceT,OptionsT> options)
Parameter
Name Description
options ServiceOptions<ServiceT,OptionsT>

Fields

credentials

protected Credentials credentials
Field Value
Type Description
com.google.auth.Credentials

Methods

build()

protected abstract ServiceOptions<ServiceT,OptionsT> build()
Returns
Type Description
ServiceOptions<ServiceT,OptionsT>

getAllowedClientLibTokens()

protected Set<String> getAllowedClientLibTokens()
Returns
Type Description
Set<String>

self()

protected B self()
Returns
Type Description
B

setApiTracerFactory(ApiTracerFactory apiTracerFactory)

public B setApiTracerFactory(ApiTracerFactory apiTracerFactory)

Sets the ApiTracerFactory. It will be used to create an ApiTracer that is annotated throughout the lifecycle of an RPC operation.

Parameter
Name Description
apiTracerFactory ApiTracerFactory
Returns
Type Description
B

setClientLibToken(String clientLibToken)

public B setClientLibToken(String clientLibToken)
Parameter
Name Description
clientLibToken String
Returns
Type Description
B

setClock(ApiClock clock)

public B setClock(ApiClock clock)

Sets the service's clock. The clock is mainly used for testing purpose. ApiClock will be replaced by Java8's java.time.Clock.

Parameter
Name Description
clock ApiClock

the clock to set
Returns
Type Description
B

the builder

setCredentials(Credentials credentials)

public B setCredentials(Credentials credentials)

Sets the service authentication credentials. If no credentials are set, GoogleCredentials#getApplicationDefault() will be used to attempt getting credentials from the environment. Use NoCredentials#getInstance() to skip authentication, this is typically useful when using local service emulators.

Parameter
Name Description
credentials com.google.auth.Credentials

authentication credentials, should not be null
Returns
Type Description
B

the builder

setHeaderProvider(HeaderProvider headerProvider)

public B setHeaderProvider(HeaderProvider headerProvider)

Sets the static header provider. 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 HeaderProvider

the header provider
Returns
Type Description
B

the builder

setHost(String host)

public B setHost(String host)

Sets service host.

Parameter
Name Description
host String
Returns
Type Description
B

the builder

setProjectId(String projectId)

public B setProjectId(String projectId)

Sets the project ID. If no project ID is set, #getDefaultProjectId() will be used to attempt getting the project ID from the environment.

Parameter
Name Description
projectId String
Returns
Type Description
B

the builder

setQuotaProjectId(String quotaProjectId)

public B setQuotaProjectId(String quotaProjectId)

Sets the quotaProjectId that specifies the project used for quota and billing purposes. See Also: See system parameter $userProject

Parameter
Name Description
quotaProjectId String
Returns
Type Description
B

setRetrySettings(RetrySettings retrySettings)

public B setRetrySettings(RetrySettings retrySettings)

Sets configuration parameters for request retries.

Parameter
Name Description
retrySettings RetrySettings
Returns
Type Description
B

the builder

setServiceFactory(ServiceFactory<ServiceT,OptionsT> serviceFactory)

public B setServiceFactory(ServiceFactory<ServiceT,OptionsT> serviceFactory)

Sets the service factory.

Parameter
Name Description
serviceFactory ServiceFactory<ServiceT,OptionsT>
Returns
Type Description
B

setServiceRpcFactory(ServiceRpcFactory<OptionsT> serviceRpcFactory)

public B setServiceRpcFactory(ServiceRpcFactory<OptionsT> serviceRpcFactory)

Sets the factory for rpc services.

Parameter
Name Description
serviceRpcFactory ServiceRpcFactory<OptionsT>
Returns
Type Description
B

the builder

setTransportOptions(TransportOptions transportOptions)

public B setTransportOptions(TransportOptions transportOptions)

Sets the transport options.

Parameter
Name Description
transportOptions TransportOptions
Returns
Type Description
B

the builder

setUniverseDomain(String universeDomain)

public B setUniverseDomain(String universeDomain)

Universe Domain is the domain for Google Cloud Services. A Google Cloud endpoint follows the format of {ServiceName}.{UniverseDomain}. For example, speech.googleapis.com would have a Universe Domain value of googleapis.com and cloudasset.test.com would have a Universe Domain of test.com.

If this value is not set, the resolved UniverseDomain will default to googleapis.com.

Parameter
Name Description
universeDomain String
Returns
Type Description
B