Reference documentation and code samples for the Cloud Firestore V1 Client class ExecutePipelineRequest.
The request for Firestore.ExecutePipeline .
Generated from protobuf message google.firestore.v1.ExecutePipelineRequest
Namespace
Google \ Cloud \ Firestore \ V1Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ database
string
Required. Database identifier, in the form projects/{project}/databases/{database}
.
↳ structured_pipeline
↳ transaction
string
Run the query within an already active transaction. The value here is the opaque transaction ID to execute the query in.
↳ new_transaction
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.
↳ read_time
Google\Protobuf\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.
getDatabase
Required. Database identifier, in the form projects/{project}/databases/{database}
.
string
setDatabase
Required. Database identifier, in the form projects/{project}/databases/{database}
.
var
string
$this
getStructuredPipeline
A pipelined operation.
hasStructuredPipeline
setStructuredPipeline
A pipelined operation.
$this
getTransaction
Run the query within an already active transaction.
The value here is the opaque transaction ID to execute the query in.
string
hasTransaction
setTransaction
Run the query within an already active transaction.
The value here is the opaque transaction ID to execute the query in.
var
string
$this
getNewTransaction
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.
hasNewTransaction
setNewTransaction
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
getReadTime
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.
hasReadTime
setReadTime
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
getPipelineType
string
getConsistencySelector
string
