Package com.couchbase.client.java.view

Interface ViewResult

All Superinterfaces:
Iterable<ViewRow>
All Known Implementing Classes:
DefaultViewResult
@Committed
@Public
public interface ViewResult
extends Iterable<ViewRow>
Represents the result from a ViewQuery.
Since:
2.0
Author:
Michael Nitschinger

  • Method Details

    • allRows

      List<ViewRow> allRows()
      Collects all rows received from the view with the default view timeout. This method throws: - TimeoutException wrapped in a RuntimeException: If the timeout is exceeded.
      Returns:
      a (potentially empty) List containing view rows.

    • allRows

      List<ViewRow> allRows​(long timeout, TimeUnit timeUnit)
      Collects all rows received from the view with the default view timeout. This method throws: - TimeoutException wrapped in a RuntimeException: If the timeout is exceeded.
      Returns:
      a (potentially empty) List containing view rows.

    • rows

      Iterator<ViewRow> rows()
      Emits one ViewRow for each row received from the view with the default view timeout. This method throws: - TimeoutException wrapped in a RuntimeException: If the timeout is exceeded.
      Returns:
      a (potentially empty) Iterator containing view rows.

    • rows

      Iterator<ViewRow> rows​(long timeout, TimeUnit timeUnit)
      Emits one ViewRow for each row received from the view with a custom timeout. This method throws: - TimeoutException wrapped in a RuntimeException: If the timeout is exceeded.
      Parameters:
      timeout - the custom timeout.
      timeUnit - the time unit for the custom timeout.
      Returns:
      a (potentially empty) Iterator containing view rows.

    • totalRows

      int totalRows()
      The total number of rows.
      Returns:
      number of rows.

    • success

      boolean success()
      If the query was successful.
      Returns:
      true if it was, false otherwise.

    • error

      JsonObject error()
      If it was not successful, an error is contained here.
      Returns:
      the potential error.

    • error

      JsonObject error​(long timeout, TimeUnit timeUnit)
      If it was not successful, an error is contained here.
      Returns:
      the potential error.

    • debug

      JsonObject debug()
      If debug was enabled on the query, it is contained here.
      Returns:
      the debug info.