Send feedback
Class ExplainOptions.Builder (3.33.3)
Version latestkeyboard_arrow_down
public static final class ExplainOptions . Builder extends GeneratedMessageV3 . Builder<ExplainOptions . Builder > implements ExplainOptionsOrBuilder
Explain options for the query.
Protobuf type google.firestore.v1.ExplainOptions
Inherited Members
com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)
com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)
com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)
Static Methods
getDescriptor()
public static final Descriptors . Descriptor getDescriptor ()
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public ExplainOptions . Builder addRepeatedField ( Descriptors . FieldDescriptor field , Object value )
Overrides
build()
public ExplainOptions build ()
buildPartial()
public ExplainOptions buildPartial ()
clear()
public ExplainOptions . Builder clear ()
Overrides
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];
clearField(Descriptors.FieldDescriptor field)
public ExplainOptions . Builder clearField ( Descriptors . FieldDescriptor field )
Overrides
clearOneof(Descriptors.OneofDescriptor oneof)
public ExplainOptions . Builder clearOneof ( Descriptors . OneofDescriptor oneof )
Overrides
clone()
public ExplainOptions . Builder clone ()
Overrides
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];
Returns
Type Description
boolean The analyze.
getDefaultInstanceForType()
public ExplainOptions getDefaultInstanceForType ()
getDescriptorForType()
public Descriptors . Descriptor getDescriptorForType ()
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Overrides
isInitialized()
public final boolean isInitialized ()
Overrides
mergeFrom(ExplainOptions other)
public ExplainOptions . Builder mergeFrom ( ExplainOptions other )
public ExplainOptions . Builder mergeFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
Overrides
mergeFrom(Message other)
public ExplainOptions . Builder mergeFrom ( Message other )
Parameter
Name Description
otherMessage
Overrides
mergeUnknownFields(UnknownFieldSet unknownFields)
public final ExplainOptions . Builder mergeUnknownFields ( UnknownFieldSet unknownFields )
Overrides
setAnalyze(boolean value)
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];
Parameter
Name Description
valueboolean The analyze to set.
setField(Descriptors.FieldDescriptor field, Object value)
public ExplainOptions . Builder setField ( Descriptors . FieldDescriptor field , Object value )
Overrides
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public ExplainOptions . Builder setRepeatedField ( Descriptors . FieldDescriptor field , int index , Object value )
Overrides
setUnknownFields(UnknownFieldSet unknownFields)
public final ExplainOptions . Builder setUnknownFields ( UnknownFieldSet unknownFields )
Overrides
Send feedback
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-10-29 UTC.
Need to tell us more?
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-10-29 UTC."],[],[]]
