Stage(mapping=None, *, ignore_unknown_fields=False, **kwargs)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.
Attributes |
|
|---|---|
| Name | Description |
name |
str
Required. The name of the stage to evaluate. **Requires:** - must be in snake case (lower case with underscore separator). |
args |
MutableSequence[google.cloud.firestore_v1.types.Value]
Optional. Ordered list of arguments the given stage expects. |
options |
MutableMapping[str, google.cloud.firestore_v1.types.Value]
Optional. Optional named arguments that certain functions may support. |
Classes
OptionsEntry
OptionsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)The abstract base class for a message.
| Parameters | |
|---|---|
| Name | Description |
kwargs |
dict
Keys and values corresponding to the fields of the message. |
mapping |
Union[dict,
A dictionary or message to be used to determine the values for this message. |
ignore_unknown_fields |
Optional(bool)
If True, do not raise errors for unknown fields. Only applied if |