Package com.google.cloud.firestore

Class ExplainStats

java.lang.Object
com.google.cloud.firestore.ExplainStats
@BetaApi public final class ExplainStats extends Object
A wrapper object to access explain stats if explain or analyze was enabled for the Pipeline query execution.

  • Method Summary

    Modifier and Type
    Method
    Description
    com.google.protobuf.Any
    getRawData()
    Returns the explain stats in an encoded proto format, as returned from the Firestore backend.
    String
    getText()
    When explain stats were requested with `outputFormat = 'text'`, this returns the explain stats string verbatim as returned from the Firestore backend.

    Methods inherited from class java.lang.Object

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

  • Method Details

    • getRawData

      @Nonnull public com.google.protobuf.Any getRawData()
      Returns the explain stats in an encoded proto format, as returned from the Firestore backend. The caller is responsible for unpacking this proto message.

    • getText

      @Nonnull public String getText()
      When explain stats were requested with `outputFormat = 'text'`, this returns the explain stats string verbatim as returned from the Firestore backend.

      If explain stats were requested with `outputFormat = 'json'`, this returns the explain stats as stringified JSON, which was returned from the Firestore backend.