Package com.google.cloud.firestore

Class ExplainOptions

java.lang.Object

com.google.cloud.firestore.ExplainOptions

public abstract class ExplainOptions
extends Object

Options used to configure explain queries.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ExplainOptions.Builder

Constructor Summary

Constructors

Constructor	Description
ExplainOptions()

Method Summary

Modifier and Type	Method	Description
static ExplainOptions.Builder	builder()
abstract boolean	getAnalyze()	Returns whether analyzing the query is enabled.
abstract ExplainOptions.Builder	toBuilder()
ExplainOptions	toProto()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ExplainOptions

public ExplainOptions()

Method Details

getAnalyze

public abstract boolean getAnalyze()

Returns whether analyzing the query is enabled. If enabled, the query will be executed and execution statistics will be returned as part of the [ExplainResults]ExplainResults.

builder

public static ExplainOptions.Builder builder()

toBuilder

public abstract ExplainOptions.Builder toBuilder()

toProto

public ExplainOptions toProto()