Package com.google.cloud.firestore

Class Pipeline.Snapshot

java.lang.Object

com.google.cloud.firestore.Pipeline.Snapshot

Enclosing class:

Pipeline

@BetaApi
public static final class Pipeline.Snapshot
extends Object

A Snapshot contains the results of a pipeline execution. It can be used to access the documents, execution time, and explain stats.

Method Summary

Modifier and Type	Method	Description
com.google.cloud.Timestamp	getExecutionTime()	The time at which the pipeline producing this result is executed.
ExplainStats	getExplainStats()	Return stats from query explain.
List<PipelineResult>	getResults()	An array of all the results in the `Snapshot`.

Methods inherited from class java.lang.Object

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

Method Details

getResults

@Nonnull
public List<PipelineResult> getResults()

An array of all the results in the `Snapshot`.

Returns:

The list of results.

getExecutionTime

@Nonnull
public com.google.cloud.Timestamp getExecutionTime()

The time at which the pipeline producing this result is executed.

Returns:

The execution time of the pipeline.

getExplainStats

@Nullable
public ExplainStats getExplainStats()

Return stats from query explain.

If `explainOptions.mode` was set to `execute` or left unset, then this returns `null`.

Returns:

The explain stats, or `null` if not available.