com.google.cloud

Class ServiceOptions.Builder<ServiceT extends Service<OptionsT>,ServiceRpcT,OptionsT extends ServiceOptions<ServiceT,ServiceRpcT,OptionsT>,B extends ServiceOptions.Builder<ServiceT,ServiceRpcT,OptionsT,B>>

java.lang.Object

com.google.cloud.ServiceOptions.Builder<ServiceT,ServiceRpcT,OptionsT,B>

Type Parameters:

ServiceT - the service subclass

ServiceRpcT - the spi-layer class corresponding to the service

OptionsT - the ServiceOptions subclass corresponding to the service

B - the ServiceOptions builder

Enclosing class:

ServiceOptions<ServiceT extends Service<OptionsT>,ServiceRpcT,OptionsT extends ServiceOptions<ServiceT,ServiceRpcT,OptionsT>>

protected abstract static class ServiceOptions.Builder<ServiceT extends Service<OptionsT>,ServiceRpcT,OptionsT extends ServiceOptions<ServiceT,ServiceRpcT,OptionsT>,B extends ServiceOptions.Builder<ServiceT,ServiceRpcT,OptionsT,B>>
extends Object

Builder for ServiceOptions.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ServiceOptions.Builder()
protected	ServiceOptions.Builder(ServiceOptions<ServiceT,ServiceRpcT,OptionsT> options)

Method Summary

Methods

Modifier and Type	Method and Description
B	authCredentials(AuthCredentials authCredentials) Sets the service authentication credentials.
protected abstract ServiceOptions<ServiceT,ServiceRpcT,OptionsT>	build()
B	clock(Clock clock) Sets the service's clock.
B	connectTimeout(int connectTimeout) Sets the timeout in milliseconds to establish a connection.
B	host(String host) Sets service host.
B	httpTransportFactory(ServiceOptions.HttpTransportFactory httpTransportFactory) Sets the transport factory.
B	projectId(String projectId) Sets project id.
B	readTimeout(int readTimeout) Sets the timeout in milliseconds to read data from an established connection.
B	retryParams(RetryParams retryParams) Sets configuration parameters for request retries.
protected B	self()
B	serviceFactory(ServiceFactory<ServiceT,OptionsT> serviceFactory) Sets the service factory.
B	serviceRpcFactory(ServiceRpcFactory<ServiceRpcT,OptionsT> serviceRpcFactory) Sets the factory for rpc services.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ServiceOptions.Builder

protected ServiceOptions.Builder()

ServiceOptions.Builder

protected ServiceOptions.Builder(ServiceOptions<ServiceT,ServiceRpcT,OptionsT> options)

Method Detail

build

protected abstract ServiceOptions<ServiceT,ServiceRpcT,OptionsT> build()

self

protected B self()

serviceFactory

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

Sets the service factory.

clock

public B clock(Clock clock)

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

Parameters:

clock - the clock to set

Returns:

the builder

projectId

public B projectId(String projectId)

Sets project id.

Returns:

the builder

host

public B host(String host)

Sets service host.

Returns:

the builder

httpTransportFactory

public B httpTransportFactory(ServiceOptions.HttpTransportFactory httpTransportFactory)

Sets the transport factory.

Returns:

the builder

authCredentials

public B authCredentials(AuthCredentials authCredentials)

Sets the service authentication credentials.

Returns:

the builder

retryParams

public B retryParams(RetryParams retryParams)

Sets configuration parameters for request retries. If no configuration is set RetryParams.defaultInstance() is used. To disable retries, supply RetryParams.noRetries() here.

Returns:

the builder

serviceRpcFactory

public B serviceRpcFactory(ServiceRpcFactory<ServiceRpcT,OptionsT> serviceRpcFactory)

Sets the factory for rpc services.

Returns:

the builder

connectTimeout

public B connectTimeout(int connectTimeout)

Sets the timeout in milliseconds to establish a connection.

Parameters:

connectTimeout - connection timeout in milliseconds. 0 for an infinite timeout, a negative number for the default value (20000).

Returns:

the builder

readTimeout

public B readTimeout(int readTimeout)

Sets the timeout in milliseconds to read data from an established connection.

Parameters:

readTimeout - read timeout in milliseconds. 0 for an infinite timeout, a negative number for the default value (20000).

Returns:

the builder