com.google.cloud

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

java.lang.Object

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

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

Type Parameters:

ServiceT - the service subclass

ServiceRpcT - the spi-layer class corresponding to the service

OptionsT - the GrpcServiceOptions subclass corresponding to the service

B - the ServiceOptions builder

Enclosing class:

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

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

Builder for GrpcServiceOptions.

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract GrpcServiceOptions<ServiceT,ServiceRpcT,OptionsT>	build()
B	executorFactory(GrpcServiceOptions.ExecutorFactory<ScheduledExecutorService> executorFactory) Sets the scheduled executor factory.
B	initialTimeout(int initialTimeout) Sets the timeout for the initial RPC, in milliseconds.
B	maxTimeout(int maxTimeout) Sets the maximum timeout for a RPC call, in milliseconds.
B	timeoutMultiplier(double timeoutMultiplier) Sets the timeout multiplier.

Methods inherited from class com.google.cloud.ServiceOptions.Builder

authCredentials, clock, host, projectId, retryParams, self, serviceFactory, serviceRpcFactory

Methods inherited from class java.lang.Object

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

Constructor Detail

GrpcServiceOptions.Builder

protected GrpcServiceOptions.Builder()

GrpcServiceOptions.Builder

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

Method Detail

build

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

Specified by:

build in class ServiceOptions.Builder<ServiceT extends Service<OptionsT>,ServiceRpcT,OptionsT extends GrpcServiceOptions<ServiceT,ServiceRpcT,OptionsT>,B extends GrpcServiceOptions.Builder<ServiceT,ServiceRpcT,OptionsT,B>>

executorFactory

public B executorFactory(GrpcServiceOptions.ExecutorFactory<ScheduledExecutorService> executorFactory)

Sets the scheduled executor factory. This method can be used to provide an user-defined scheduled executor to execute requests.

Returns:

the builder

initialTimeout

public B initialTimeout(int initialTimeout)

Sets the timeout for the initial RPC, in milliseconds. Subsequent calls will use this value adjusted according to timeoutMultiplier(double). Default value is 20000.

Returns:

the builder

Throws:

IllegalArgumentException - if the provided timeout is < 0

timeoutMultiplier

public B timeoutMultiplier(double timeoutMultiplier)

Sets the timeout multiplier. This value is used to compute the timeout for a retried RPC. Timeout is computed as timeoutMultiplier * previousTimeout. Default value is 1.5.

Returns:

the builder

Throws:

IllegalArgumentException - if the provided timeout multiplier is < 0

maxTimeout

public B maxTimeout(int maxTimeout)

Sets the maximum timeout for a RPC call, in milliseconds. Default value is 100000. If maxTimeout is lower than the initial timeout the initialTimeout(int) value is used instead.

Returns:

the builder