Send feedback
Class ExplainOptions (3.27.2)
Stay organized with collections
Save and categorize content based on your preferences.
Version 3.27.2 keyboard_arrow_down
public final class ExplainOptions extends GeneratedMessageV3 implements ExplainOptionsOrBuilder
Explain options for the query.
Protobuf type google.firestore.v1.ExplainOptions
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
ANALYZE_FIELD_NUMBER
public static final int ANALYZE_FIELD_NUMBER
Field Value
Type Description
int
Static Methods
getDefaultInstance()
public static ExplainOptions getDefaultInstance ()
getDescriptor()
public static final Descriptors . Descriptor getDescriptor ()
newBuilder()
public static ExplainOptions . Builder newBuilder ()
newBuilder(ExplainOptions prototype)
public static ExplainOptions . Builder newBuilder ( ExplainOptions prototype )
public static ExplainOptions parseDelimitedFrom ( InputStream input )
public static ExplainOptions parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(byte[] data)
public static ExplainOptions parseFrom ( byte [] data )
Parameter
Name Description
databyte []
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static ExplainOptions parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteString data)
public static ExplainOptions parseFrom ( ByteString data )
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ExplainOptions parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
public static ExplainOptions parseFrom ( CodedInputStream input )
public static ExplainOptions parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
public static ExplainOptions parseFrom ( InputStream input )
public static ExplainOptions parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteBuffer data)
public static ExplainOptions parseFrom ( ByteBuffer data )
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static ExplainOptions parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
parser()
public static Parser<ExplainOptions> parser ()
Methods
equals(Object obj)
public boolean equals ( Object obj )
Parameter
Name Description
objObject
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 ()
getParserForType()
public Parser<ExplainOptions> getParserForType ()
Overrides
getSerializedSize()
public int getSerializedSize ()
Returns
Type Description
int
Overrides
hashCode()
Returns
Type Description
int
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Overrides
isInitialized()
public final boolean isInitialized ()
Overrides
newBuilderForType()
public ExplainOptions . Builder newBuilderForType ()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected ExplainOptions . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Returns
Type Description
Object
Overrides
toBuilder()
public ExplainOptions . Builder toBuilder ()
writeTo(CodedOutputStream output)
public void writeTo ( CodedOutputStream output )
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-01-28 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-01-28 UTC."],[],[]]
