Show / Hide Table of Contents

Class 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
Stage
Implements
IDirectResponseSchema
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Google.Apis.Firestore.v1.Data
Assembly: Google.Apis.Firestore.v1.dll
Syntax
public class Stage : IDirectResponseSchema

Properties

Args

Optional. Ordered list of arguments the given stage expects.

Declaration
[JsonProperty("args")]
public virtual IList<Value> Args { get; set; }
Property Value
Type Description
IList<Value>

ETag

The ETag of the item.

Declaration
public virtual string ETag { get; set; }
Property Value
Type Description
string

Name

Required. The name of the stage to evaluate. Requires: * must be in snake case (lower case with underscore separator).

Declaration
[JsonProperty("name")]
public virtual string Name { get; set; }
Property Value
Type Description
string

Options

Optional. Optional named arguments that certain functions may support.

Declaration
[JsonProperty("options")]
public virtual IDictionary<string, Value> Options { get; set; }
Property Value
Type Description
IDictionary<string, Value>

Implements

IDirectResponseSchema
In this article
Back to top Generated by DocFX