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.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ database |
string
Required. Database identifier, in the form |
↳ structured_pipeline |
StructuredPipeline
A pipelined operation. |
↳ 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}.
| Returns | |
|---|---|
| Type | Description |
string |
|
setDatabase
Required. Database identifier, in the form
projects/{project}/databases/{database}.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getStructuredPipeline
A pipelined operation.
| Returns | |
|---|---|
| Type | Description |
StructuredPipeline|null |
|
hasStructuredPipeline
setStructuredPipeline
A pipelined operation.
| Parameter | |
|---|---|
| Name | Description |
var |
StructuredPipeline
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getTransaction
Run the query within an already active transaction.
The value here is the opaque transaction ID to execute the query in.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasTransaction
setTransaction
Run the query within an already active transaction.
The value here is the opaque transaction ID to execute the query in.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$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.
| Returns | |
|---|---|
| Type | Description |
TransactionOptions|null |
|
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.
| Parameter | |
|---|---|
| Name | Description |
var |
TransactionOptions
|
| Returns | |
|---|---|
| Type | Description |
$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.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
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.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPipelineType
| Returns | |
|---|---|
| Type | Description |
string |
|
getConsistencySelector
| Returns | |
|---|---|
| Type | Description |
string |
|