Package com.google.firestore.v1

Interface ExecutePipelineRequestOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
ExecutePipelineRequest, ExecutePipelineRequest.Builder
public interface ExecutePipelineRequestOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • getDatabase

      String getDatabase()
       Required. Database identifier, in the form
 `projects/{project}/databases/{database}`.
      string database = 1 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The database.

    • getDatabaseBytes

      com.google.protobuf.ByteString getDatabaseBytes()
       Required. Database identifier, in the form
 `projects/{project}/databases/{database}`.
      string database = 1 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The bytes for database.

    • hasStructuredPipeline

      boolean hasStructuredPipeline()
       A pipelined operation.
      .google.firestore.v1.StructuredPipeline structured_pipeline = 2;
      Returns:
      Whether the structuredPipeline field is set.

    • getStructuredPipeline

      StructuredPipeline getStructuredPipeline()
       A pipelined operation.
      .google.firestore.v1.StructuredPipeline structured_pipeline = 2;
      Returns:
      The structuredPipeline.

    • getStructuredPipelineOrBuilder

      StructuredPipelineOrBuilder getStructuredPipelineOrBuilder()
       A pipelined operation.
      .google.firestore.v1.StructuredPipeline structured_pipeline = 2;

    • hasTransaction

      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:
      Whether the transaction field is set.

    • getTransaction

      com.google.protobuf.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:
      The transaction.

    • hasNewTransaction

      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:
      Whether the newTransaction field is set.

    • getNewTransaction

      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:
      The newTransaction.

    • getNewTransactionOrBuilder

      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;

    • hasReadTime

      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:
      Whether the readTime field is set.

    • getReadTime

      com.google.protobuf.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:
      The readTime.

    • getReadTimeOrBuilder

      com.google.protobuf.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;

    • getPipelineTypeCase

      ExecutePipelineRequest.PipelineTypeCase getPipelineTypeCase()

    • getConsistencySelectorCase

      ExecutePipelineRequest.ConsistencySelectorCase getConsistencySelectorCase()