Package com.google.firestore.v1

Class ExplainOptions.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessageV3.Builder<ExplainOptions.Builder>
com.google.firestore.v1.ExplainOptions.Builder
All Implemented Interfaces:
ExplainOptionsOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
ExplainOptions
public static final class ExplainOptions.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<ExplainOptions.Builder> implements ExplainOptionsOrBuilder
 Explain options for the query.
Protobuf type google.firestore.v1.ExplainOptions

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<ExplainOptions.Builder>

    • clear

      public ExplainOptions.Builder clear()
      Specified by:
      clear in interface com.google.protobuf.Message.Builder
      Specified by:
      clear in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clear in class com.google.protobuf.GeneratedMessageV3.Builder<ExplainOptions.Builder>

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<ExplainOptions.Builder>

    • getDefaultInstanceForType

      public ExplainOptions getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

    • build

      public ExplainOptions build()
      Specified by:
      build in interface com.google.protobuf.Message.Builder
      Specified by:
      build in interface com.google.protobuf.MessageLite.Builder

    • buildPartial

      public ExplainOptions buildPartial()
      Specified by:
      buildPartial in interface com.google.protobuf.Message.Builder
      Specified by:
      buildPartial in interface com.google.protobuf.MessageLite.Builder

    • clone

      public ExplainOptions.Builder clone()
      Specified by:
      clone in interface com.google.protobuf.Message.Builder
      Specified by:
      clone in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clone in class com.google.protobuf.GeneratedMessageV3.Builder<ExplainOptions.Builder>

    • setField

      public ExplainOptions.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
      Specified by:
      setField in interface com.google.protobuf.Message.Builder
      Overrides:
      setField in class com.google.protobuf.GeneratedMessageV3.Builder<ExplainOptions.Builder>

    • clearField

      public ExplainOptions.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
      Specified by:
      clearField in interface com.google.protobuf.Message.Builder
      Overrides:
      clearField in class com.google.protobuf.GeneratedMessageV3.Builder<ExplainOptions.Builder>

    • clearOneof

      public ExplainOptions.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
      Specified by:
      clearOneof in interface com.google.protobuf.Message.Builder
      Overrides:
      clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<ExplainOptions.Builder>

    • setRepeatedField

      public ExplainOptions.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
      Specified by:
      setRepeatedField in interface com.google.protobuf.Message.Builder
      Overrides:
      setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<ExplainOptions.Builder>

    • addRepeatedField

      public ExplainOptions.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
      Specified by:
      addRepeatedField in interface com.google.protobuf.Message.Builder
      Overrides:
      addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<ExplainOptions.Builder>

    • mergeFrom

      public ExplainOptions.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<ExplainOptions.Builder>

    • mergeFrom

      public ExplainOptions.Builder mergeFrom(ExplainOptions other)

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<ExplainOptions.Builder>

    • mergeFrom

      public ExplainOptions.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<ExplainOptions.Builder>
      Throws:
      IOException

    • getAnalyze

      public 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];
      Specified by:
      getAnalyze in interface ExplainOptionsOrBuilder
      Returns:
      The analyze.

    • setAnalyze

      public ExplainOptions.Builder setAnalyze(boolean value)
       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];
      Parameters:
      value - The analyze to set.
      Returns:
      This builder for chaining.

    • clearAnalyze

      public ExplainOptions.Builder clearAnalyze()
       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:
      This builder for chaining.

    • setUnknownFields

      public final ExplainOptions.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
      Specified by:
      setUnknownFields in interface com.google.protobuf.Message.Builder
      Overrides:
      setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<ExplainOptions.Builder>

    • mergeUnknownFields

      public final ExplainOptions.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
      Specified by:
      mergeUnknownFields in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<ExplainOptions.Builder>