Package io.confluent.ksql.api.client

Class BatchedQueryResult

java.lang.Object

java.util.concurrent.CompletableFuture<List<Row>>

io.confluent.ksql.api.client.BatchedQueryResult

All Implemented Interfaces:

CompletionStage<List<Row>>, Future<List<Row>>

public abstract class BatchedQueryResult
extends CompletableFuture<List<Row>>

The result of a query (push or pull), returned as a single batch once the query has finished executing, or the query has been terminated. For non-terminating push queries, StreamedQueryResult should be used instead.

If a non-200 response is received from the server, this future will complete exceptionally.

The maximum number of Rows that may be returned from a BatchedQueryResult defaults to ClientOptions.DEFAULT_EXECUTE_QUERY_MAX_RESULT_ROWS and can be configured via ClientOptions.setExecuteQueryMaxResultRows(int).

Nested Class Summary

Nested classes/interfaces inherited from class java.util.concurrent.CompletableFuture

CompletableFuture.AsynchronousCompletionTask

Constructor Summary

Constructors

Constructor	Description
BatchedQueryResult()

Method Summary

Modifier and Type	Method	Description
abstract CompletableFuture<String>	queryID()	Returns a CompletableFuture containing the ID of the underlying query if the query is a push query, else null.

Methods inherited from class java.util.concurrent.CompletableFuture

acceptEither, acceptEitherAsync, acceptEitherAsync, allOf, anyOf, applyToEither, applyToEitherAsync, applyToEitherAsync, cancel, complete, completeAsync, completeAsync, completedFuture, completedStage, completeExceptionally, completeOnTimeout, copy, defaultExecutor, delayedExecutor, delayedExecutor, exceptionally, exceptionallyAsync, exceptionallyAsync, exceptionallyCompose, exceptionallyComposeAsync, exceptionallyComposeAsync, failedFuture, failedStage, get, get, getNow, getNumberOfDependents, handle, handleAsync, handleAsync, isCancelled, isCompletedExceptionally, isDone, join, minimalCompletionStage, newIncompleteFuture, obtrudeException, obtrudeValue, orTimeout, runAfterBoth, runAfterBothAsync, runAfterBothAsync, runAfterEither, runAfterEitherAsync, runAfterEitherAsync, runAsync, runAsync, supplyAsync, supplyAsync, thenAccept, thenAcceptAsync, thenAcceptAsync, thenAcceptBoth, thenAcceptBothAsync, thenAcceptBothAsync, thenApply, thenApplyAsync, thenApplyAsync, thenCombine, thenCombineAsync, thenCombineAsync, thenCompose, thenComposeAsync, thenComposeAsync, thenRun, thenRunAsync, thenRunAsync, toCompletableFuture, toString, whenComplete, whenCompleteAsync, whenCompleteAsync

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

BatchedQueryResult

public BatchedQueryResult()

Method Details

queryID

public abstract CompletableFuture<String> queryID()

Returns a CompletableFuture containing the ID of the underlying query if the query is a push query, else null. The future is completed once a response is received from the server.

If a non-200 response is received from the server, this future will complete exceptionally.

Returns:

a future containing the query ID (or null in the case of pull queries)