Class Pipeline.Snapshot (3.35.1)

public static final class Pipeline.Snapshot

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

Inheritance

java.lang.Object > Pipeline.Snapshot

Methods

getExecutionTime()

public Timestamp getExecutionTime()

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

Returns
Type Description
com.google.cloud.Timestamp

The execution time of the pipeline.

getExplainStats()

public ExplainStats getExplainStats()

Return stats from query explain.

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

Returns
Type Description
ExplainStats

The explain stats, or null if not available.

getResults()

public List<PipelineResult> getResults()

An array of all the results in the Snapshot.

Returns
Type Description
List<PipelineResult>

The list of results.