public interface ExecutePipelineRequestOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
getConsistencySelectorCase()
public abstract ExecutePipelineRequest.ConsistencySelectorCase getConsistencySelectorCase()| Returns | |
|---|---|
| Type | Description |
ExecutePipelineRequest.ConsistencySelectorCase |
|
getDatabase()
public abstract String getDatabase() Required. Database identifier, in the form
projects/{project}/databases/{database}.
string database = 1 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
String |
The database. |
getDatabaseBytes()
public abstract ByteString getDatabaseBytes() Required. Database identifier, in the form
projects/{project}/databases/{database}.
string database = 1 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for database. |
getNewTransaction()
public abstract TransactionOptions 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.
.google.firestore.v1.TransactionOptions new_transaction = 6;
| Returns | |
|---|---|
| Type | Description |
TransactionOptions |
The newTransaction. |
getNewTransactionOrBuilder()
public abstract TransactionOptionsOrBuilder getNewTransactionOrBuilder()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.
.google.firestore.v1.TransactionOptions new_transaction = 6;
| Returns | |
|---|---|
| Type | Description |
TransactionOptionsOrBuilder |
|
getPipelineTypeCase()
public abstract ExecutePipelineRequest.PipelineTypeCase getPipelineTypeCase()| Returns | |
|---|---|
| Type | Description |
ExecutePipelineRequest.PipelineTypeCase |
|
getReadTime()
public abstract Timestamp 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.
.google.protobuf.Timestamp read_time = 7;
| Returns | |
|---|---|
| Type | Description |
Timestamp |
The readTime. |
getReadTimeOrBuilder()
public abstract TimestampOrBuilder getReadTimeOrBuilder()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.
.google.protobuf.Timestamp read_time = 7;
| Returns | |
|---|---|
| Type | Description |
TimestampOrBuilder |
|
getStructuredPipeline()
public abstract StructuredPipeline getStructuredPipeline()A pipelined operation.
.google.firestore.v1.StructuredPipeline structured_pipeline = 2;
| Returns | |
|---|---|
| Type | Description |
StructuredPipeline |
The structuredPipeline. |
getStructuredPipelineOrBuilder()
public abstract StructuredPipelineOrBuilder getStructuredPipelineOrBuilder()A pipelined operation.
.google.firestore.v1.StructuredPipeline structured_pipeline = 2;
| Returns | |
|---|---|
| Type | Description |
StructuredPipelineOrBuilder |
|
getTransaction()
public abstract ByteString getTransaction()Run the query within an already active transaction.
The value here is the opaque transaction ID to execute the query in.
bytes transaction = 5;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The transaction. |
hasNewTransaction()
public abstract boolean hasNewTransaction()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.
.google.firestore.v1.TransactionOptions new_transaction = 6;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the newTransaction field is set. |
hasReadTime()
public abstract boolean hasReadTime()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.
.google.protobuf.Timestamp read_time = 7;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the readTime field is set. |
hasStructuredPipeline()
public abstract boolean hasStructuredPipeline()A pipelined operation.
.google.firestore.v1.StructuredPipeline structured_pipeline = 2;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the structuredPipeline field is set. |
hasTransaction()
public abstract boolean hasTransaction()Run the query within an already active transaction.
The value here is the opaque transaction ID to execute the query in.
bytes transaction = 5;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the transaction field is set. |