Class SpannerOptions.SpannerCallContextTimeoutConfigurator (6.89.0)

public static class SpannerOptions.SpannerCallContextTimeoutConfigurator implements SpannerOptions.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.
 Context context =
     Context.current()
         .withValue(
             SpannerOptions.CALL_CONTEXT_CONFIGURATOR_KEY,
             SpannerCallContextTimeoutConfigurator.create()
                 .withExecuteQueryTimeout(Duration.ofSeconds(10L)));
 context.run(
     () -> {
       try (ResultSet rs =
           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 (SpannerException e) {
         if (e.getErrorCode() == ErrorCode.DEADLINE_EXCEEDED) {
           // Handle timeout.
         }
       }
     }
 

Inheritance

java.lang.Object > SpannerOptions.SpannerCallContextTimeoutConfigurator

Static Methods

create()

public static SpannerOptions.SpannerCallContextTimeoutConfigurator create()
Returns
TypeDescription
SpannerOptions.SpannerCallContextTimeoutConfigurator

Methods

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

public ApiCallContext <ReqT,RespT>configure(ApiCallContext context, ReqT request, 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()

public Duration getBatchUpdateTimeout()

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

Returns
TypeDescription
org.threeten.bp.Duration

getBatchUpdateTimeoutDuration()

public Duration getBatchUpdateTimeoutDuration()
Returns
TypeDescription
Duration

getCommitTimeout()

public Duration getCommitTimeout()

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

Returns
TypeDescription
org.threeten.bp.Duration

getCommitTimeoutDuration()

public Duration getCommitTimeoutDuration()
Returns
TypeDescription
Duration

getExecuteQueryTimeout()

public Duration getExecuteQueryTimeout()

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

Returns
TypeDescription
org.threeten.bp.Duration

getExecuteQueryTimeoutDuration()

public Duration getExecuteQueryTimeoutDuration()
Returns
TypeDescription
Duration

getExecuteUpdateTimeout()

public Duration getExecuteUpdateTimeout()

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

Returns
TypeDescription
org.threeten.bp.Duration

getExecuteUpdateTimeoutDuration()

public Duration getExecuteUpdateTimeoutDuration()
Returns
TypeDescription
Duration

getPartitionQueryTimeout()

public Duration getPartitionQueryTimeout()

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

Returns
TypeDescription
org.threeten.bp.Duration

getPartitionQueryTimeoutDuration()

public Duration getPartitionQueryTimeoutDuration()
Returns
TypeDescription
Duration

getPartitionReadTimeout()

public Duration getPartitionReadTimeout()

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

Returns
TypeDescription
org.threeten.bp.Duration

getPartitionReadTimeoutDuration()

public Duration getPartitionReadTimeoutDuration()
Returns
TypeDescription
Duration

getReadTimeout()

public Duration getReadTimeout()

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

Returns
TypeDescription
org.threeten.bp.Duration

getReadTimeoutDuration()

public Duration getReadTimeoutDuration()
Returns
TypeDescription
Duration

getRollbackTimeout()

public Duration getRollbackTimeout()

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

Returns
TypeDescription
org.threeten.bp.Duration

getRollbackTimeoutDuration()

public Duration getRollbackTimeoutDuration()
Returns
TypeDescription
Duration

withBatchUpdateTimeout(Duration batchUpdateTimeout)

public SpannerOptions.SpannerCallContextTimeoutConfigurator withBatchUpdateTimeout(Duration batchUpdateTimeout)

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

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

withBatchUpdateTimeoutDuration(Duration batchUpdateTimeout)

public SpannerOptions.SpannerCallContextTimeoutConfigurator withBatchUpdateTimeoutDuration(Duration batchUpdateTimeout)
Parameter
NameDescription
batchUpdateTimeoutDuration
Returns
TypeDescription
SpannerOptions.SpannerCallContextTimeoutConfigurator

withCommitTimeout(Duration commitTimeout)

public SpannerOptions.SpannerCallContextTimeoutConfigurator withCommitTimeout(Duration commitTimeout)

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

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

withCommitTimeoutDuration(Duration commitTimeout)

public SpannerOptions.SpannerCallContextTimeoutConfigurator withCommitTimeoutDuration(Duration commitTimeout)
Parameter
NameDescription
commitTimeoutDuration
Returns
TypeDescription
SpannerOptions.SpannerCallContextTimeoutConfigurator

withExecuteQueryTimeout(Duration executeQueryTimeout)

public SpannerOptions.SpannerCallContextTimeoutConfigurator withExecuteQueryTimeout(Duration executeQueryTimeout)

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

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

withExecuteQueryTimeoutDuration(Duration executeQueryTimeout)

public SpannerOptions.SpannerCallContextTimeoutConfigurator withExecuteQueryTimeoutDuration(Duration executeQueryTimeout)
Parameter
NameDescription
executeQueryTimeoutDuration
Returns
TypeDescription
SpannerOptions.SpannerCallContextTimeoutConfigurator

withExecuteUpdateTimeout(Duration executeUpdateTimeout)

public SpannerOptions.SpannerCallContextTimeoutConfigurator withExecuteUpdateTimeout(Duration executeUpdateTimeout)

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

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

withExecuteUpdateTimeoutDuration(Duration executeUpdateTimeout)

public SpannerOptions.SpannerCallContextTimeoutConfigurator withExecuteUpdateTimeoutDuration(Duration executeUpdateTimeout)
Parameter
NameDescription
executeUpdateTimeoutDuration
Returns
TypeDescription
SpannerOptions.SpannerCallContextTimeoutConfigurator

withPartitionQueryTimeout(Duration partitionQueryTimeout)

public SpannerOptions.SpannerCallContextTimeoutConfigurator withPartitionQueryTimeout(Duration partitionQueryTimeout)

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

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

withPartitionQueryTimeoutDuration(Duration partitionQueryTimeout)

public SpannerOptions.SpannerCallContextTimeoutConfigurator withPartitionQueryTimeoutDuration(Duration partitionQueryTimeout)
Parameter
NameDescription
partitionQueryTimeoutDuration
Returns
TypeDescription
SpannerOptions.SpannerCallContextTimeoutConfigurator

withPartitionReadTimeout(Duration partitionReadTimeout)

public SpannerOptions.SpannerCallContextTimeoutConfigurator withPartitionReadTimeout(Duration partitionReadTimeout)

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

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

withPartitionReadTimeoutDuration(Duration partitionReadTimeout)

public SpannerOptions.SpannerCallContextTimeoutConfigurator withPartitionReadTimeoutDuration(Duration partitionReadTimeout)
Parameter
NameDescription
partitionReadTimeoutDuration
Returns
TypeDescription
SpannerOptions.SpannerCallContextTimeoutConfigurator

withReadTimeout(Duration readTimeout)

public SpannerOptions.SpannerCallContextTimeoutConfigurator withReadTimeout(Duration readTimeout)

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

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

withReadTimeoutDuration(Duration readTimeout)

public SpannerOptions.SpannerCallContextTimeoutConfigurator withReadTimeoutDuration(Duration readTimeout)
Parameter
NameDescription
readTimeoutDuration
Returns
TypeDescription
SpannerOptions.SpannerCallContextTimeoutConfigurator

withRollbackTimeout(Duration rollbackTimeout)

public SpannerOptions.SpannerCallContextTimeoutConfigurator withRollbackTimeout(Duration rollbackTimeout)

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

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

withRollbackTimeoutDuration(Duration rollbackTimeout)

public SpannerOptions.SpannerCallContextTimeoutConfigurator withRollbackTimeoutDuration(Duration rollbackTimeout)
Parameter
NameDescription
rollbackTimeoutDuration
Returns
TypeDescription
SpannerOptions.SpannerCallContextTimeoutConfigurator