Firestore v1 API - Class Pipeline.Types.Stage (4.2.0) 

public sealed class Pipeline.Types.Stage : IMessage<Pipeline.Types.Stage>, IEquatable<Pipeline.Types.Stage>, IDeepCloneable<Pipeline.Types.Stage>, IBufferMessage, IMessage

Reference documentation and code samples for the Firestore v1 API class Pipeline.Types.Stage.

A single operation within a pipeline.

A stage is made up of a unique name, and a list of arguments. The exact number of arguments & types is dependent on the stage type.

To give an example, the stage filter(state = "MD") would be encoded as:

name: "filter"
args {
  function_value {
    name: "eq"
    args { field_reference_value: "state" }
    args { string_value: "MD" }
  }
}

See public documentation for the full list.

Inheritance

object > Pipeline.Types.Stage

Namespace

Google.Cloud.Firestore.V1

Assembly

Google.Cloud.Firestore.V1.dll

Constructors

Stage()

public Stage()

Stage(Stage)

public Stage(Pipeline.Types.Stage other)
Parameter
Name Description
other PipelineTypesStage

Properties

Args

public RepeatedField<Value> Args { get; }

Optional. Ordered list of arguments the given stage expects.

Property Value
Type Description
RepeatedFieldValue

Name

public string Name { get; set; }

Required. The name of the stage to evaluate.

Requires:

  • must be in snake case (lower case with underscore separator).
Property Value
Type Description
string

Options

public MapField<string, Value> Options { get; }

Optional. Optional named arguments that certain functions may support.

Property Value
Type Description
MapFieldstringValue