Package com.google.cloud.spanner
Class SpannerOptions.SpannerCallContextTimeoutConfigurator
java.lang.Object
com.google.cloud.spanner.SpannerOptions.SpannerCallContextTimeoutConfigurator
- All Implemented Interfaces:
SpannerOptions.CallContextConfigurator
- Enclosing class:
- SpannerOptions
public static class SpannerOptions.SpannerCallContextTimeoutConfigurator
extends Object
implements SpannerOptions.CallContextConfigurator
Helper class to configure timeouts for specific Spanner RPCs. The
SpannerOptions.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.
}
}
}
-
Method Summary
Modifier and TypeMethodDescription<ReqT,RespT>
com.google.api.gax.rpc.ApiCallContextconfigure(com.google.api.gax.rpc.ApiCallContext context, ReqT request, io.grpc.MethodDescriptor<ReqT, RespT> method) Configure aApiCallContextfor a specific RPC call.create()org.threeten.bp.DurationThis method is obsolete.org.threeten.bp.DurationThis method is obsolete.org.threeten.bp.DurationThis method is obsolete.org.threeten.bp.DurationThis method is obsolete.org.threeten.bp.DurationThis method is obsolete.org.threeten.bp.DurationThis method is obsolete.org.threeten.bp.DurationThis method is obsolete.org.threeten.bp.DurationThis method is obsolete.withBatchUpdateTimeout(org.threeten.bp.Duration batchUpdateTimeout) This method is obsolete.withBatchUpdateTimeoutDuration(Duration batchUpdateTimeout) withCommitTimeout(org.threeten.bp.Duration commitTimeout) This method is obsolete.withCommitTimeoutDuration(Duration commitTimeout) withExecuteQueryTimeout(org.threeten.bp.Duration executeQueryTimeout) This method is obsolete.withExecuteQueryTimeoutDuration(Duration executeQueryTimeout) withExecuteUpdateTimeout(org.threeten.bp.Duration executeUpdateTimeout) This method is obsolete.withExecuteUpdateTimeoutDuration(Duration executeUpdateTimeout) withPartitionQueryTimeout(org.threeten.bp.Duration partitionQueryTimeout) This method is obsolete.withPartitionQueryTimeoutDuration(Duration partitionQueryTimeout) withPartitionReadTimeout(org.threeten.bp.Duration partitionReadTimeout) This method is obsolete.withPartitionReadTimeoutDuration(Duration partitionReadTimeout) withReadTimeout(org.threeten.bp.Duration readTimeout) This method is obsolete.withReadTimeoutDuration(Duration readTimeout) withRollbackTimeout(org.threeten.bp.Duration rollbackTimeout) This method is obsolete.withRollbackTimeoutDuration(Duration rollbackTimeout)
-
Method Details
-
create
-
configure
public <ReqT,RespT> com.google.api.gax.rpc.ApiCallContext configure(com.google.api.gax.rpc.ApiCallContext context, ReqT request, io.grpc.MethodDescriptor<ReqT, RespT> method) Description copied from interface:SpannerOptions.CallContextConfiguratorConfigure aApiCallContextfor a specific RPC call.- Specified by:
configurein interfaceSpannerOptions.CallContextConfigurator- Parameters:
context- The default context. This can be used to inspect the current values.request- The request that will be sent.method- The method that is being called.- Returns:
- An
ApiCallContextthat will be merged with the defaultApiCallContext. Ifnullis returned, no changes to the defaultApiCallContextwill be made.
-
getCommitTimeout
@ObsoleteApi("Use getCommitTimeoutDuration() instead.") public org.threeten.bp.Duration getCommitTimeout()This method is obsolete. UsegetCommitTimeoutDuration()instead. -
getCommitTimeoutDuration
-
withCommitTimeout
@ObsoleteApi("Use withCommitTimeoutDuration() instead.") public SpannerOptions.SpannerCallContextTimeoutConfigurator withCommitTimeout(org.threeten.bp.Duration commitTimeout) This method is obsolete. UsewithCommitTimeoutDuration(Duration)instead. -
withCommitTimeoutDuration
public SpannerOptions.SpannerCallContextTimeoutConfigurator withCommitTimeoutDuration(Duration commitTimeout) -
getRollbackTimeout
@ObsoleteApi("Use getRollbackTimeoutDuration() instead.") public org.threeten.bp.Duration getRollbackTimeout()This method is obsolete. UsegetRollbackTimeoutDuration()instead. -
getRollbackTimeoutDuration
-
withRollbackTimeout
@ObsoleteApi("Use withRollbackTimeoutDuration() instead.") public SpannerOptions.SpannerCallContextTimeoutConfigurator withRollbackTimeout(org.threeten.bp.Duration rollbackTimeout) This method is obsolete. UsewithRollbackTimeoutDuration(Duration)instead. -
withRollbackTimeoutDuration
public SpannerOptions.SpannerCallContextTimeoutConfigurator withRollbackTimeoutDuration(Duration rollbackTimeout) -
getExecuteQueryTimeout
@ObsoleteApi("Use getExecuteQueryTimeoutDuration() instead.") public org.threeten.bp.Duration getExecuteQueryTimeout()This method is obsolete. UsegetExecuteQueryTimeoutDuration()instead. -
getExecuteQueryTimeoutDuration
-
withExecuteQueryTimeout
@ObsoleteApi("Use withExecuteQueryTimeoutDuration() instead") public SpannerOptions.SpannerCallContextTimeoutConfigurator withExecuteQueryTimeout(org.threeten.bp.Duration executeQueryTimeout) This method is obsolete. UsewithExecuteQueryTimeoutDuration(Duration)instead. -
withExecuteQueryTimeoutDuration
public SpannerOptions.SpannerCallContextTimeoutConfigurator withExecuteQueryTimeoutDuration(Duration executeQueryTimeout) -
getExecuteUpdateTimeout
@ObsoleteApi("Use getExecuteUpdateTimeoutDuration() instead") public org.threeten.bp.Duration getExecuteUpdateTimeout()This method is obsolete. UsegetExecuteUpdateTimeoutDuration()instead. -
getExecuteUpdateTimeoutDuration
-
withExecuteUpdateTimeout
@ObsoleteApi("Use withExecuteUpdateTimeoutDuration() instead") public SpannerOptions.SpannerCallContextTimeoutConfigurator withExecuteUpdateTimeout(org.threeten.bp.Duration executeUpdateTimeout) This method is obsolete. UsewithExecuteUpdateTimeoutDuration(Duration)instead. -
withExecuteUpdateTimeoutDuration
public SpannerOptions.SpannerCallContextTimeoutConfigurator withExecuteUpdateTimeoutDuration(Duration executeUpdateTimeout) -
getBatchUpdateTimeout
@ObsoleteApi("Use getBatchUpdateTimeoutDuration() instead") public org.threeten.bp.Duration getBatchUpdateTimeout()This method is obsolete. UsegetBatchUpdateTimeoutDuration()instead. -
getBatchUpdateTimeoutDuration
-
withBatchUpdateTimeout
@ObsoleteApi("Use withBatchUpdateTimeoutDuration() instead") public SpannerOptions.SpannerCallContextTimeoutConfigurator withBatchUpdateTimeout(org.threeten.bp.Duration batchUpdateTimeout) This method is obsolete. UsewithBatchUpdateTimeoutDuration(Duration)instead. -
withBatchUpdateTimeoutDuration
public SpannerOptions.SpannerCallContextTimeoutConfigurator withBatchUpdateTimeoutDuration(Duration batchUpdateTimeout) -
getReadTimeout
@ObsoleteApi("Use getReadTimeoutDuration() instead") public org.threeten.bp.Duration getReadTimeout()This method is obsolete. UsegetReadTimeoutDuration()instead. -
getReadTimeoutDuration
-
withReadTimeout
@ObsoleteApi("Use withReadTimeoutDuration() instead") public SpannerOptions.SpannerCallContextTimeoutConfigurator withReadTimeout(org.threeten.bp.Duration readTimeout) This method is obsolete. UsewithReadTimeoutDuration(Duration)instead. -
withReadTimeoutDuration
public SpannerOptions.SpannerCallContextTimeoutConfigurator withReadTimeoutDuration(Duration readTimeout) -
getPartitionQueryTimeout
@ObsoleteApi("Use getPartitionQueryTimeoutDuration() instead") public org.threeten.bp.Duration getPartitionQueryTimeout()This method is obsolete. UsegetPartitionQueryTimeoutDuration()instead. -
getPartitionQueryTimeoutDuration
-
withPartitionQueryTimeout
@ObsoleteApi("Use withPartitionQueryTimeoutDuration() instead") public SpannerOptions.SpannerCallContextTimeoutConfigurator withPartitionQueryTimeout(org.threeten.bp.Duration partitionQueryTimeout) This method is obsolete. UsewithPartitionQueryTimeoutDuration(Duration)instead. -
withPartitionQueryTimeoutDuration
public SpannerOptions.SpannerCallContextTimeoutConfigurator withPartitionQueryTimeoutDuration(Duration partitionQueryTimeout) -
getPartitionReadTimeout
@ObsoleteApi("Use getPartitionReadTimeoutDuration() instead") public org.threeten.bp.Duration getPartitionReadTimeout()This method is obsolete. UsegetPartitionReadTimeoutDuration()instead. -
getPartitionReadTimeoutDuration
-
withPartitionReadTimeout
@ObsoleteApi("Use withPartitionReadTimeoutDuration() instead") public SpannerOptions.SpannerCallContextTimeoutConfigurator withPartitionReadTimeout(org.threeten.bp.Duration partitionReadTimeout) This method is obsolete. UsewithPartitionReadTimeoutDuration(Duration)instead. -
withPartitionReadTimeoutDuration
public SpannerOptions.SpannerCallContextTimeoutConfigurator withPartitionReadTimeoutDuration(Duration partitionReadTimeout)
-