Cloud Firestore V1 API - Class Google::Cloud::Firestore::V1::StructuredPipeline (v2.3.0)

Reference documentation and code samples for the Cloud Firestore V1 API class Google::Cloud::Firestore::V1::StructuredPipeline.

A Firestore query represented as an ordered list of operations / stages.

This is considered the top-level function which plans and executes a query. It is logically equivalent to query(stages, options), but prevents the client from having to build a function wrapper.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#options

def options() -> ::Google::Protobuf::Map{::String => ::Google::Cloud::Firestore::V1::Value}
Returns
  • (::Google::Protobuf::Map{::String => ::Google::Cloud::Firestore::V1::Value}) — Optional. Optional query-level arguments.

#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 query-level arguments.
Returns
  • (::Google::Protobuf::Map{::String => ::Google::Cloud::Firestore::V1::Value}) — Optional. Optional query-level arguments.

#pipeline

def pipeline() -> ::Google::Cloud::Firestore::V1::Pipeline
Returns

#pipeline=

def pipeline=(value) -> ::Google::Cloud::Firestore::V1::Pipeline
Parameter
Returns