Reference documentation and code samples for the Cloud Firestore V1 Client 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.
Generated from protobuf message google.firestore.v1.Pipeline.Stage
Namespace
Google \ Cloud \ Firestore \ V1 \ PipelineMethods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ name
string
Required. The name of the stage to evaluate. Requires:* * must be in snake case (lower case with underscore separator).
↳ args
array< Google\Cloud\Firestore\V1\Value
>
Optional. Ordered list of arguments the given stage expects.
↳ options
array| Google\Protobuf\Internal\MapField
Optional. Optional named arguments that certain functions may support.
getName
Required. The name of the stage to evaluate.
Requires:
- must be in snake case (lower case with underscore separator).
string
setName
Required. The name of the stage to evaluate.
Requires:
- must be in snake case (lower case with underscore separator).
var
string
$this
getArgs
Optional. Ordered list of arguments the given stage expects.
setArgs
Optional. Ordered list of arguments the given stage expects.
$this
getOptions
Optional. Optional named arguments that certain functions may support.
setOptions
Optional. Optional named arguments that certain functions may support.
$this
