Class ExplainOptions (3.20.0)

public final class ExplainOptions extends GeneratedMessageV3 implements ExplainOptionsOrBuilder

Explain options for the query.

Protobuf type google.firestore.v1.ExplainOptions

Static Fields

ANALYZE_FIELD_NUMBER

public static final int ANALYZE_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static ExplainOptions getDefaultInstance()
Returns
TypeDescription
ExplainOptions

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static ExplainOptions.Builder newBuilder()
Returns
TypeDescription
ExplainOptions.Builder

newBuilder(ExplainOptions prototype)

public static ExplainOptions.Builder newBuilder(ExplainOptions prototype)
Parameter
NameDescription
prototypeExplainOptions
Returns
TypeDescription
ExplainOptions.Builder

parseDelimitedFrom(InputStream input)

public static ExplainOptions parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
ExplainOptions
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ExplainOptions parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ExplainOptions
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static ExplainOptions parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
ExplainOptions
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ExplainOptions parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ExplainOptions
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ExplainOptions parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
ExplainOptions
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ExplainOptions parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ExplainOptions
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ExplainOptions parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
ExplainOptions
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ExplainOptions parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ExplainOptions
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static ExplainOptions parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
ExplainOptions
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ExplainOptions parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ExplainOptions
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static ExplainOptions parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
ExplainOptions
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ExplainOptions parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ExplainOptions
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<ExplainOptions> parser()
Returns
TypeDescription
Parser<ExplainOptions>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
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
TypeDescription
boolean

The analyze.

getDefaultInstanceForType()

public ExplainOptions getDefaultInstanceForType()
Returns
TypeDescription
ExplainOptions

getParserForType()

public Parser<ExplainOptions> getParserForType()
Returns
TypeDescription
Parser<ExplainOptions>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public ExplainOptions.Builder newBuilderForType()
Returns
TypeDescription
ExplainOptions.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected ExplainOptions.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
ExplainOptions.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public ExplainOptions.Builder toBuilder()
Returns
TypeDescription
ExplainOptions.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException