Uses of Class
com.google.cloud.firestore.Pipeline

Packages that use Pipeline

Package	Description
com.google.cloud.firestore
com.google.cloud.firestore.pipeline.stages

Uses of Pipeline in com.google.cloud.firestore

Methods in com.google.cloud.firestore that return Pipeline

Modifier and Type	Method	Description
Pipeline	Pipeline.addFields(Selectable field, Selectable... additionalFields)	Adds new fields to outputs from previous stages.
Pipeline	Pipeline.aggregate(AliasedAggregate... accumulators)	Performs aggregation operations on the documents from previous stages.
Pipeline	Pipeline.aggregate(Aggregate aggregate)	Performs optionally grouped aggregation operations on the documents from previous stages.
Pipeline	Pipeline.aggregate(Aggregate aggregate, AggregateOptions options)
Pipeline	PipelineSource.collection(CollectionReference ref)
Pipeline	PipelineSource.collection(String path)	Creates a new Pipeline that operates on the specified Firestore collection.
Pipeline	PipelineSource.collection(String path, CollectionOptions options)
Pipeline	PipelineSource.collectionGroup(String collectionId)	Creates a new Pipeline that operates on all documents in a collection group.
Pipeline	PipelineSource.collectionGroup(String collectionId, CollectionGroupOptions options)
Pipeline	PipelineSource.createFrom(AggregateQuery query)	Creates a new Pipeline from the given AggregateQuery.
Pipeline	PipelineSource.createFrom(Query query)	Creates a new Pipeline from the given Query.
Pipeline	PipelineSource.database()	Creates a new Pipeline that operates on all documents in the Firestore database.
Pipeline	Pipeline.distinct(Selectable... selectables)	Returns a set of distinct Expression values from the inputs to this stage.
Pipeline	Pipeline.distinct(String... fields)	Returns a set of distinct field values from the inputs to this stage.
Pipeline	PipelineSource.documents(DocumentReference... docs)	Creates a new Pipeline that operates on a specific set of Firestore documents.
Pipeline	PipelineSource.documents(String... docs)	Creates a new Pipeline that operates on a specific set of Firestore documents.
Pipeline	Pipeline.findNearest(Expression property, double[] vector, FindNearest.DistanceMeasure distanceMeasure, FindNearestOptions options)	Performs vector distance (similarity) search with given parameters to the stage inputs.
Pipeline	Pipeline.findNearest(String fieldName, double[] vector, FindNearest.DistanceMeasure distanceMeasure, FindNearestOptions options)	Performs vector distance (similarity) search with given parameters to the stage inputs.
Pipeline	Pipeline.limit(int limit)	Limits the maximum number of documents returned by previous stages to `limit`.
Pipeline	Pipeline.offset(int offset)	Skips the first `offset` number of documents from the results of previous stages.
Pipeline	Pipeline.rawStage(RawStage stage)	Adds a generic stage to the pipeline.
Pipeline	Pipeline.removeFields(Field field, Field... additionalFields)	Remove fields from outputs of previous stages.
Pipeline	Pipeline.removeFields(String field, String... additionalFields)	Remove fields from outputs of previous stages.
Pipeline	Pipeline.replaceWith(Expression expr)	Fully overwrites all fields in a document with those coming from a nested map.
Pipeline	Pipeline.replaceWith(String fieldName)	Fully overwrites all fields in a document with those coming from a nested map.
Pipeline	Pipeline.sample(int limit)	Performs a pseudo-random sampling of the documents from the previous stage.
Pipeline	Pipeline.sample(Sample sample)	Performs a pseudo-random sampling of the documents from the previous stage.
Pipeline	Pipeline.select(Selectable selection, Selectable... additionalSelections)	Selects or creates a set of fields from the outputs of previous stages.
Pipeline	Pipeline.select(String field, String... additionalFields)	Selects a set of fields from the outputs of previous stages.
Pipeline	Pipeline.sort(Ordering... orders)	Sorts the documents from previous stages based on one or more Ordering criteria.
Pipeline	Pipeline.union(Pipeline other)	Performs union of all documents from two pipelines, including duplicates.
Pipeline	Pipeline.unnest(Selectable expr)	Produces a document for each element in array found in previous stage document.
Pipeline	Pipeline.unnest(Selectable field, UnnestOptions options)	Produces a document for each element in array found in previous stage document.
Pipeline	Pipeline.unnest(String fieldName, String alias)	Produces a document for each element in array found in previous stage document.
Pipeline	Pipeline.unnest(String fieldName, String alias, UnnestOptions options)	Produces a document for each element in array found in previous stage document.
Pipeline	Pipeline.where(BooleanExpression condition)	Filters the documents from previous stages to only include those matching the specified BooleanExpression.

Methods in com.google.cloud.firestore with parameters of type Pipeline

Modifier and Type	Method	Description
abstract com.google.api.core.ApiFuture<Pipeline.Snapshot>	Transaction.execute(Pipeline pipeline)	Executes the provided pipeline within the transaction context.
abstract com.google.api.core.ApiFuture<Pipeline.Snapshot>	Transaction.execute(Pipeline pipeline, PipelineExecuteOptions options)	Executes the provided pipeline with specified options, within the transaction context.
Pipeline	Pipeline.union(Pipeline other)	Performs union of all documents from two pipelines, including duplicates.

Uses of Pipeline in com.google.cloud.firestore.pipeline.stages

Constructors in com.google.cloud.firestore.pipeline.stages with parameters of type Pipeline

Modifier	Constructor	Description
	Union(Pipeline other)