RawStage

class RawStage : Stage


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

Public companion functions

RawStage
ofName(name: String)

Specify name of stage

Public functions

RawStage
withArguments(vararg arguments: Any)

Specify arguments to stage.

Inherited functions

From com.google.firebase.firestore.pipeline.Stage
RawStage
RawStage
withOption(key: String, value: Boolean)

Specify named Boolean parameter

RawStage
withOption(key: String, value: Double)

Specify named Double parameter

RawStage
withOption(key: String, value: Field)

Specify named Field parameter

RawStage
withOption(key: String, value: Long)

Specify named Long parameter

RawStage
withOption(key: String, value: String)

Specify named String parameter

Public companion functions

ofName

fun ofName(name: String): RawStage

Specify name of stage

Parameters
name: String

The unique name of the stage to add.

Returns
RawStage

A new RawStage for the specified stage name.

Public functions

withArguments

fun withArguments(vararg arguments: Any): RawStage

Specify arguments to stage.

Parameters
vararg arguments: Any

A list of ordered parameters to configure the stage's behavior.

Returns
RawStage

RawStage with specified parameters.