com.google.cloud.bigtable.grpc

Interface DeadlineGenerator

@InternalApi(value="For internal usage only")
public interface DeadlineGenerator

A provider for RPC timeouts and deadlines for a given Bigtable client operation, governing both the full operation and retry attempts within an operation. A single DeadlineGenerator object should be used for a client operation instance and reused across retry attempts.

Field Summary

Fields

Modifier and Type	Field and Description
static DeadlineGenerator	DEFAULT The default instance will return: - CallOptions.DEFAULT with any Context.current()'s Context.getDeadline() applied to it.
static long	UNARY_DEADLINE_MINUTES The server-side has a 5 minute timeout.

Method Summary

Modifier and Type	Method and Description
com.google.common.base.Optional<Long>	getOperationTimeoutMs() Returns the operation timeout (if configured) in millisecond to use for this RPC, covering all retry attempts.
com.google.common.base.Optional<io.grpc.Deadline>	getRpcAttemptDeadline() Provides a Deadline object to be used in a single RPC attempt.

Field Detail

UNARY_DEADLINE_MINUTES

static final long UNARY_DEADLINE_MINUTES

The server-side has a 5 minute timeout. Unary operations should be timed-out on the client side after 6 minutes.

See Also:

Constant Field Values

DEFAULT

static final DeadlineGenerator DEFAULT

The default instance will return: - CallOptions.DEFAULT with any Context.current()'s Context.getDeadline() applied to it. - The operation timeout of 6 minutes.

For internal use only - public for technical reasons.

Method Detail

getOperationTimeoutMs

com.google.common.base.Optional<Long> getOperationTimeoutMs()

Returns the operation timeout (if configured) in millisecond to use for this RPC, covering all retry attempts. Single attempt timeouts are governed by getRpcAttemptDeadline() ()}.

getRpcAttemptDeadline

com.google.common.base.Optional<io.grpc.Deadline> getRpcAttemptDeadline()

Provides a Deadline object to be used in a single RPC attempt. Deadline can contain state, specifically start time with an expiration is set; in cases when timeouts are used, implementations should invoke this method each time this method is called.