Class SpannerOptions.SpannerCallContextTimeoutConfigurator (6.89.0)

publicstaticclassSpannerOptions.SpannerCallContextTimeoutConfiguratorimplementsSpannerOptions.CallContextConfigurator

Helper class to configure timeouts for specific Spanner RPCs. The SpannerCallContextTimeoutConfigurator must be set as a value on the Context using the SpannerOptions#CALL_CONTEXT_CONFIGURATOR_KEY key.

Example usage:

// Create a context with a ExecuteQuery timeout of 10 seconds.Contextcontext=Context.current().withValue(SpannerOptions.CALL_CONTEXT_CONFIGURATOR_KEY,SpannerCallContextTimeoutConfigurator.create().withExecuteQueryTimeout(Duration.ofSeconds(10L)));context.run(()->{try(ResultSetrs=client.singleUse().executeQuery(Statement.of("SELECT SingerId, FirstName, LastName FROM Singers ORDER BY LastName"))){while(rs.next()){System.out.printf("%d %s %s%n",rs.getLong(0),rs.getString(1),rs.getString(2));}}catch(SpannerExceptione){if(e.getErrorCode()==ErrorCode.DEADLINE_EXCEEDED){// Handle timeout.}}}

Inheritance

java.lang.Object > SpannerOptions.SpannerCallContextTimeoutConfigurator

Static Methods

create()

publicstaticSpannerOptions.SpannerCallContextTimeoutConfiguratorcreate()
Returns
TypeDescription
SpannerOptions.SpannerCallContextTimeoutConfigurator

Methods

<ReqT,RespT>configure(ApiCallContext context, ReqT request, MethodDescriptor<ReqT,RespT> method)

publicApiCallContext<ReqT,RespT>configure(ApiCallContextcontext,ReqTrequest,MethodDescriptor<ReqT,RespT>method)

Configure a ApiCallContext for a specific RPC call.

Parameters
NameDescription
contextApiCallContext
requestReqT
methodio.grpc.MethodDescriptor<ReqT,RespT>
Returns
TypeDescription
ApiCallContext

getBatchUpdateTimeout()

publicDurationgetBatchUpdateTimeout()

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

Returns
TypeDescription
org.threeten.bp.Duration

getBatchUpdateTimeoutDuration()

publicDurationgetBatchUpdateTimeoutDuration()
Returns
TypeDescription
Duration

getCommitTimeout()

publicDurationgetCommitTimeout()

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

Returns
TypeDescription
org.threeten.bp.Duration

getCommitTimeoutDuration()

publicDurationgetCommitTimeoutDuration()
Returns
TypeDescription
Duration

getExecuteQueryTimeout()

publicDurationgetExecuteQueryTimeout()

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

Returns
TypeDescription
org.threeten.bp.Duration

getExecuteQueryTimeoutDuration()

publicDurationgetExecuteQueryTimeoutDuration()
Returns
TypeDescription
Duration

getExecuteUpdateTimeout()

publicDurationgetExecuteUpdateTimeout()

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

Returns
TypeDescription
org.threeten.bp.Duration

getExecuteUpdateTimeoutDuration()

publicDurationgetExecuteUpdateTimeoutDuration()
Returns
TypeDescription
Duration

getPartitionQueryTimeout()

publicDurationgetPartitionQueryTimeout()

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

Returns
TypeDescription
org.threeten.bp.Duration

getPartitionQueryTimeoutDuration()

publicDurationgetPartitionQueryTimeoutDuration()
Returns
TypeDescription
Duration

getPartitionReadTimeout()

publicDurationgetPartitionReadTimeout()

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

Returns
TypeDescription
org.threeten.bp.Duration

getPartitionReadTimeoutDuration()

publicDurationgetPartitionReadTimeoutDuration()
Returns
TypeDescription
Duration

getReadTimeout()

publicDurationgetReadTimeout()

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

Returns
TypeDescription
org.threeten.bp.Duration

getReadTimeoutDuration()

publicDurationgetReadTimeoutDuration()
Returns
TypeDescription
Duration

getRollbackTimeout()

publicDurationgetRollbackTimeout()

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

Returns
TypeDescription
org.threeten.bp.Duration

getRollbackTimeoutDuration()

publicDurationgetRollbackTimeoutDuration()
Returns
TypeDescription
Duration

withBatchUpdateTimeout(Duration batchUpdateTimeout)

publicSpannerOptions.SpannerCallContextTimeoutConfiguratorwithBatchUpdateTimeout(DurationbatchUpdateTimeout)

This method is obsolete. Use #withBatchUpdateTimeoutDuration(Duration) instead.

Parameter
NameDescription
batchUpdateTimeoutorg.threeten.bp.Duration
Returns
TypeDescription
SpannerOptions.SpannerCallContextTimeoutConfigurator

withBatchUpdateTimeoutDuration(Duration batchUpdateTimeout)

publicSpannerOptions.SpannerCallContextTimeoutConfiguratorwithBatchUpdateTimeoutDuration(DurationbatchUpdateTimeout)
Parameter
NameDescription
batchUpdateTimeoutDuration
Returns
TypeDescription
SpannerOptions.SpannerCallContextTimeoutConfigurator

withCommitTimeout(Duration commitTimeout)

publicSpannerOptions.SpannerCallContextTimeoutConfiguratorwithCommitTimeout(DurationcommitTimeout)

This method is obsolete. Use #withCommitTimeoutDuration(Duration) instead.

Parameter
NameDescription
commitTimeoutorg.threeten.bp.Duration
Returns
TypeDescription
SpannerOptions.SpannerCallContextTimeoutConfigurator

withCommitTimeoutDuration(Duration commitTimeout)

publicSpannerOptions.SpannerCallContextTimeoutConfiguratorwithCommitTimeoutDuration(DurationcommitTimeout)
Parameter
NameDescription
commitTimeoutDuration
Returns
TypeDescription
SpannerOptions.SpannerCallContextTimeoutConfigurator

withExecuteQueryTimeout(Duration executeQueryTimeout)

publicSpannerOptions.SpannerCallContextTimeoutConfiguratorwithExecuteQueryTimeout(DurationexecuteQueryTimeout)

This method is obsolete. Use #withExecuteQueryTimeoutDuration(Duration) instead.

Parameter
NameDescription
executeQueryTimeoutorg.threeten.bp.Duration
Returns
TypeDescription
SpannerOptions.SpannerCallContextTimeoutConfigurator

withExecuteQueryTimeoutDuration(Duration executeQueryTimeout)

publicSpannerOptions.SpannerCallContextTimeoutConfiguratorwithExecuteQueryTimeoutDuration(DurationexecuteQueryTimeout)
Parameter
NameDescription
executeQueryTimeoutDuration
Returns
TypeDescription
SpannerOptions.SpannerCallContextTimeoutConfigurator

withExecuteUpdateTimeout(Duration executeUpdateTimeout)

publicSpannerOptions.SpannerCallContextTimeoutConfiguratorwithExecuteUpdateTimeout(DurationexecuteUpdateTimeout)

This method is obsolete. Use #withExecuteUpdateTimeoutDuration(Duration) instead.

Parameter
NameDescription
executeUpdateTimeoutorg.threeten.bp.Duration
Returns
TypeDescription
SpannerOptions.SpannerCallContextTimeoutConfigurator

withExecuteUpdateTimeoutDuration(Duration executeUpdateTimeout)

publicSpannerOptions.SpannerCallContextTimeoutConfiguratorwithExecuteUpdateTimeoutDuration(DurationexecuteUpdateTimeout)
Parameter
NameDescription
executeUpdateTimeoutDuration
Returns
TypeDescription
SpannerOptions.SpannerCallContextTimeoutConfigurator

withPartitionQueryTimeout(Duration partitionQueryTimeout)

publicSpannerOptions.SpannerCallContextTimeoutConfiguratorwithPartitionQueryTimeout(DurationpartitionQueryTimeout)

This method is obsolete. Use #withPartitionQueryTimeoutDuration(Duration) instead.

Parameter
NameDescription
partitionQueryTimeoutorg.threeten.bp.Duration
Returns
TypeDescription
SpannerOptions.SpannerCallContextTimeoutConfigurator

withPartitionQueryTimeoutDuration(Duration partitionQueryTimeout)

publicSpannerOptions.SpannerCallContextTimeoutConfiguratorwithPartitionQueryTimeoutDuration(DurationpartitionQueryTimeout)
Parameter
NameDescription
partitionQueryTimeoutDuration
Returns
TypeDescription
SpannerOptions.SpannerCallContextTimeoutConfigurator

withPartitionReadTimeout(Duration partitionReadTimeout)

publicSpannerOptions.SpannerCallContextTimeoutConfiguratorwithPartitionReadTimeout(DurationpartitionReadTimeout)

This method is obsolete. Use #withPartitionReadTimeoutDuration(Duration) instead.

Parameter
NameDescription
partitionReadTimeoutorg.threeten.bp.Duration
Returns
TypeDescription
SpannerOptions.SpannerCallContextTimeoutConfigurator

withPartitionReadTimeoutDuration(Duration partitionReadTimeout)

publicSpannerOptions.SpannerCallContextTimeoutConfiguratorwithPartitionReadTimeoutDuration(DurationpartitionReadTimeout)
Parameter
NameDescription
partitionReadTimeoutDuration
Returns
TypeDescription
SpannerOptions.SpannerCallContextTimeoutConfigurator

withReadTimeout(Duration readTimeout)

publicSpannerOptions.SpannerCallContextTimeoutConfiguratorwithReadTimeout(DurationreadTimeout)

This method is obsolete. Use #withReadTimeoutDuration(Duration) instead.

Parameter
NameDescription
readTimeoutorg.threeten.bp.Duration
Returns
TypeDescription
SpannerOptions.SpannerCallContextTimeoutConfigurator

withReadTimeoutDuration(Duration readTimeout)

publicSpannerOptions.SpannerCallContextTimeoutConfiguratorwithReadTimeoutDuration(DurationreadTimeout)
Parameter
NameDescription
readTimeoutDuration
Returns
TypeDescription
SpannerOptions.SpannerCallContextTimeoutConfigurator

withRollbackTimeout(Duration rollbackTimeout)

publicSpannerOptions.SpannerCallContextTimeoutConfiguratorwithRollbackTimeout(DurationrollbackTimeout)

This method is obsolete. Use #withRollbackTimeoutDuration(Duration) instead.

Parameter
NameDescription
rollbackTimeoutorg.threeten.bp.Duration
Returns
TypeDescription
SpannerOptions.SpannerCallContextTimeoutConfigurator

withRollbackTimeoutDuration(Duration rollbackTimeout)

publicSpannerOptions.SpannerCallContextTimeoutConfiguratorwithRollbackTimeoutDuration(DurationrollbackTimeout)
Parameter
NameDescription
rollbackTimeoutDuration
Returns
TypeDescription
SpannerOptions.SpannerCallContextTimeoutConfigurator