Class ExplainOptions (3.21.4)

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
Type Description
int

Static Methods

getDefaultInstance()

public static ExplainOptions getDefaultInstance()
Returns
Type Description
ExplainOptions

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static ExplainOptions.Builder newBuilder()
Returns
Type Description
ExplainOptions.Builder

newBuilder(ExplainOptions prototype)

public static ExplainOptions.Builder newBuilder(ExplainOptions prototype)
Parameter
Name Description
prototype ExplainOptions
Returns
Type Description
ExplainOptions.Builder

parseDelimitedFrom(InputStream input)

public static ExplainOptions parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ExplainOptions
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ExplainOptions parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ExplainOptions
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static ExplainOptions parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
ExplainOptions
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ExplainOptions parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ExplainOptions
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ExplainOptions parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
ExplainOptions
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ExplainOptions parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ExplainOptions
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ExplainOptions parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
ExplainOptions
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ExplainOptions parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ExplainOptions
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static ExplainOptions parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ExplainOptions
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ExplainOptions parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ExplainOptions
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static ExplainOptions parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
ExplainOptions
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ExplainOptions parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ExplainOptions
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<ExplainOptions> parser()
Returns
Type Description
Parser<ExplainOptions>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
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
Type Description
boolean

The analyze.

getDefaultInstanceForType()

public ExplainOptions getDefaultInstanceForType()
Returns
Type Description
ExplainOptions

getParserForType()

public Parser<ExplainOptions> getParserForType()
Returns
Type Description
Parser<ExplainOptions>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public ExplainOptions.Builder newBuilderForType()
Returns
Type Description
ExplainOptions.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected ExplainOptions.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
ExplainOptions.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public ExplainOptions.Builder toBuilder()
Returns
Type Description
ExplainOptions.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException