Package com.google.firestore.v1

Interface ExplainOptionsOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
ExplainOptions, ExplainOptions.Builder
public interface ExplainOptionsOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    getAnalyze()
    Optional.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Method Details

    • getAnalyze

      boolean getAnalyze()
       Optional. Whether to execute this query.

 When false (the default), the query will be planned, returning only
 metrics from the planning stages.

 When true, the query will be planned and executed, returning the full
 query results along with both planning and execution stage metrics.
      bool analyze = 1 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The analyze.