Interface SpannerRpc.ResultStreamConsumer (6.82.0)

Version 6.82.0

• 6.83.0 (latest)
• 6.82.0
• 6.80.1
• 6.79.0
• 6.77.0
• 6.74.1
• 6.72.0
• 6.71.0
• 6.69.0
• 6.68.0
• 6.66.0
• 6.65.1
• 6.62.0
• 6.60.0
• 6.58.0
• 6.57.0
• 6.56.0
• 6.55.0
• 6.54.0
• 6.53.0
• 6.52.1
• 6.51.0
• 6.50.1
• 6.49.0
• 6.25.1
• 6.24.0
• 6.23.4
• 6.22.0
• 6.21.2
• 6.20.0
• 6.19.1
• 6.18.0
• 6.17.4
• 6.14.1

public static interface SpannerRpc.ResultStreamConsumer

Consumer for the results produced by a streaming read or query call.

Methods

cancelQueryWhenClientIsClosed()

public abstract boolean cancelQueryWhenClientIsClosed()

Returns true if the stream should be cancelled when the Spanner client is closed. This returns true for com.google.cloud.spanner.BatchReadOnlyTransaction, as these use a non-pooled session. Pooled sessions are deleted when the Spanner client is closed, and this automatically also cancels any query that uses the session, which means that we don't need to explicitly cancel those queries when the Spanner client is closed.

Returns
Type	Description
boolean

onCompleted()

public abstract void onCompleted()

onError(SpannerException e)

public abstract void onError(SpannerException e)

Parameter
Name	Description
e	SpannerException

onPartialResultSet(PartialResultSet results)

public abstract void onPartialResultSet(PartialResultSet results)

Parameter
Name	Description
results	PartialResultSet