Interface QueryPlanOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
QueryPlan, QueryPlan.Builder

public interface QueryPlanOrBuilder extends com.google.protobuf.MessageOrBuilder
  • Method Summary

    Modifier and Type
    Method
    Description
    com.google.protobuf.Struct
    Planning phase information for the query.
    com.google.protobuf.StructOrBuilder
    Planning phase information for the query.
    boolean
    Planning phase information for the query.

    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

    • hasPlanInfo

      boolean hasPlanInfo()
       Planning phase information for the query. It will include:
      
       {
         "indexes_used": [
           {"query_scope": "Collection", "properties": "(foo ASC, __name__ ASC)"},
           {"query_scope": "Collection", "properties": "(bar ASC, __name__ ASC)"}
         ]
       }
       
      .google.protobuf.Struct plan_info = 1;
      Returns:
      Whether the planInfo field is set.
    • getPlanInfo

      com.google.protobuf.Struct getPlanInfo()
       Planning phase information for the query. It will include:
      
       {
         "indexes_used": [
           {"query_scope": "Collection", "properties": "(foo ASC, __name__ ASC)"},
           {"query_scope": "Collection", "properties": "(bar ASC, __name__ ASC)"}
         ]
       }
       
      .google.protobuf.Struct plan_info = 1;
      Returns:
      The planInfo.
    • getPlanInfoOrBuilder

      com.google.protobuf.StructOrBuilder getPlanInfoOrBuilder()
       Planning phase information for the query. It will include:
      
       {
         "indexes_used": [
           {"query_scope": "Collection", "properties": "(foo ASC, __name__ ASC)"},
           {"query_scope": "Collection", "properties": "(bar ASC, __name__ ASC)"}
         ]
       }
       
      .google.protobuf.Struct plan_info = 1;