Reference documentation and code samples for the Cloud Firestore V1 API class Google::Cloud::Firestore::V1::Pipeline::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.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#args
def args() -> ::Array<::Google::Cloud::Firestore::V1::Value>
Returns
- (::Array<::Google::Cloud::Firestore::V1::Value>) — Optional. Ordered list of arguments the given stage expects.
#args=
def args=(value) -> ::Array<::Google::Cloud::Firestore::V1::Value>
Parameter
- value (::Array<::Google::Cloud::Firestore::V1::Value>) — Optional. Ordered list of arguments the given stage expects.
Returns
- (::Array<::Google::Cloud::Firestore::V1::Value>) — Optional. Ordered list of arguments the given stage expects.
#name
def name() -> ::String
Returns
-
(::String) —
Required. The name of the stage to evaluate.
Requires:
- must be in snake case (lower case with underscore separator).
#name=
def name=(value) -> ::String
Parameter
-
value (::String) —
Required. The name of the stage to evaluate.
Requires:
- must be in snake case (lower case with underscore separator).
Returns
-
(::String) —
Required. The name of the stage to evaluate.
Requires:
- must be in snake case (lower case with underscore separator).
#options
def options() -> ::Google::Protobuf::Map{::String => ::Google::Cloud::Firestore::V1::Value}
Returns
- (::Google::Protobuf::Map{::String => ::Google::Cloud::Firestore::V1::Value}) — Optional. Optional named arguments that certain functions may support.
#options=
def options=(value) -> ::Google::Protobuf::Map{::String => ::Google::Cloud::Firestore::V1::Value}
Parameter
- value (::Google::Protobuf::Map{::String => ::Google::Cloud::Firestore::V1::Value}) — Optional. Optional named arguments that certain functions may support.
Returns
- (::Google::Protobuf::Map{::String => ::Google::Cloud::Firestore::V1::Value}) — Optional. Optional named arguments that certain functions may support.