Class ExecutePipelineRequest (2.27.0)

ExecutePipelineRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The request for Firestore.ExecutePipeline][google.firestore.v1.Firestore.ExecutePipeline].

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Attributes

Name Description
database str
Required. Database identifier, in the form projects/{project}/databases/{database}.
structured_pipeline google.cloud.firestore_v1.types.StructuredPipeline
A pipelined operation. This field is a member of oneof_ pipeline_type.
transaction bytes
Run the query within an already active transaction. The value here is the opaque transaction ID to execute the query in. This field is a member of oneof_ consistency_selector.
new_transaction google.cloud.firestore_v1.types.TransactionOptions
Execute the pipeline in a new transaction. The identifier of the newly created transaction will be returned in the first response on the stream. This defaults to a read-only transaction. This field is a member of oneof_ consistency_selector.
read_time google.protobuf.timestamp_pb2.Timestamp
Execute the pipeline in a snapshot transaction at the given time. This must be a microsecond precision timestamp within the past one hour, or if Point-in-Time Recovery is enabled, can additionally be a whole minute timestamp within the past 7 days. This field is a member of oneof_ consistency_selector.