RawStage

public final class RawStage extends Stage

java.lang.Object
   ↳ com.google.firebase.firestore.pipeline.Stage
     ↳ com.google.firebase.firestore.pipeline.RawStage

Adds a stage to the pipeline by specifying the stage name as an argument. This does not offer any type safety on the stage params and requires the caller to know the order (and optionally names) of parameters accepted by the stage.

This class provides a way to call stages that are supported by the Firestore backend but that are not implemented in the SDK version being used.

Summary

Nested types
public static class RawStage.Companion

Public methods
static final @NonNull RawStage

Specify name of stage
final @NonNull RawStage

Specify arguments to stage.

Inherited methods
From com.google.firebase.firestore.pipeline.Stage
final @NonNull RawStage
final @NonNull RawStage
withOption(@NonNull String key, boolean value)

Specify named Boolean parameter
final @NonNull RawStage
withOption(@NonNull String key, double value)

Specify named Double parameter
final @NonNull RawStage

Specify named Field parameter
final @NonNull RawStage
withOption(@NonNull String key, long value)

Specify named Long parameter
final @NonNull RawStage

Specify named String parameter

Public methods

ofName

public static final @NonNull RawStage ofName(@NonNull String name)

Specify name of stage

Parameters
@NonNull String name

The unique name of the stage to add.
Returns
@NonNull RawStage

A new RawStage for the specified stage name.

withArguments

public final @NonNull RawStage withArguments(@NonNull Object arguments)

Specify arguments to stage.

Parameters
@NonNull Object arguments

A list of ordered parameters to configure the stage's behavior.
Returns
@NonNull RawStage

RawStage with specified parameters.