Package com.google.firestore.v1

Class ExecutePipelineRequest

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
com.google.firestore.v1.ExecutePipelineRequest
All Implemented Interfaces:
ExecutePipelineRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
public final class ExecutePipelineRequest extends com.google.protobuf.GeneratedMessageV3 implements ExecutePipelineRequestOrBuilder
 The request for
 [Firestore.ExecutePipeline][google.firestore.v1.Firestore.ExecutePipeline].
Protobuf type google.firestore.v1.ExecutePipelineRequest
See Also:

  • Field Details

    • DATABASE_FIELD_NUMBER

      public static final int DATABASE_FIELD_NUMBER
      See Also:

    • STRUCTURED_PIPELINE_FIELD_NUMBER

      public static final int STRUCTURED_PIPELINE_FIELD_NUMBER
      See Also:

    • TRANSACTION_FIELD_NUMBER

      public static final int TRANSACTION_FIELD_NUMBER
      See Also:

    • NEW_TRANSACTION_FIELD_NUMBER

      public static final int NEW_TRANSACTION_FIELD_NUMBER
      See Also:

    • READ_TIME_FIELD_NUMBER

      public static final int READ_TIME_FIELD_NUMBER
      See Also:

  • Method Details

    • newInstance

      protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
      Overrides:
      newInstance in class com.google.protobuf.GeneratedMessageV3

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

    • getPipelineTypeCase

      public ExecutePipelineRequest.PipelineTypeCase getPipelineTypeCase()
      Specified by:
      getPipelineTypeCase in interface ExecutePipelineRequestOrBuilder

    • getConsistencySelectorCase

      public ExecutePipelineRequest.ConsistencySelectorCase getConsistencySelectorCase()
      Specified by:
      getConsistencySelectorCase in interface ExecutePipelineRequestOrBuilder

    • getDatabase

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

    • getDatabaseBytes

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

    • hasStructuredPipeline

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

    • getStructuredPipeline

      public StructuredPipeline getStructuredPipeline()
       A pipelined operation.
      .google.firestore.v1.StructuredPipeline structured_pipeline = 2;
      Specified by:
      getStructuredPipeline in interface ExecutePipelineRequestOrBuilder
      Returns:
      The structuredPipeline.

    • getStructuredPipelineOrBuilder

      public StructuredPipelineOrBuilder getStructuredPipelineOrBuilder()
       A pipelined operation.
      .google.firestore.v1.StructuredPipeline structured_pipeline = 2;
      Specified by:
      getStructuredPipelineOrBuilder in interface ExecutePipelineRequestOrBuilder

    • hasTransaction

      public 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;
      Specified by:
      hasTransaction in interface ExecutePipelineRequestOrBuilder
      Returns:
      Whether the transaction field is set.

    • getTransaction

      public 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;
      Specified by:
      getTransaction in interface ExecutePipelineRequestOrBuilder
      Returns:
      The transaction.

    • hasNewTransaction

      public 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;
      Specified by:
      hasNewTransaction in interface ExecutePipelineRequestOrBuilder
      Returns:
      Whether the newTransaction field is set.

    • getNewTransaction

      public 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;
      Specified by:
      getNewTransaction in interface ExecutePipelineRequestOrBuilder
      Returns:
      The newTransaction.

    • getNewTransactionOrBuilder

      public 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;
      Specified by:
      getNewTransactionOrBuilder in interface ExecutePipelineRequestOrBuilder

    • hasReadTime

      public 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;
      Specified by:
      hasReadTime in interface ExecutePipelineRequestOrBuilder
      Returns:
      Whether the readTime field is set.

    • getReadTime

      public 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;
      Specified by:
      getReadTime in interface ExecutePipelineRequestOrBuilder
      Returns:
      The readTime.

    • getReadTimeOrBuilder

      public 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;
      Specified by:
      getReadTimeOrBuilder in interface ExecutePipelineRequestOrBuilder

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessageV3

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessageV3
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessageV3

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static ExecutePipelineRequest parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ExecutePipelineRequest parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ExecutePipelineRequest parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ExecutePipelineRequest parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ExecutePipelineRequest parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ExecutePipelineRequest parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ExecutePipelineRequest parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static ExecutePipelineRequest parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static ExecutePipelineRequest parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static ExecutePipelineRequest parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static ExecutePipelineRequest parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static ExecutePipelineRequest parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public ExecutePipelineRequest.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static ExecutePipelineRequest.Builder newBuilder()

    • newBuilder

      public static ExecutePipelineRequest.Builder newBuilder(ExecutePipelineRequest prototype)

    • toBuilder

      public ExecutePipelineRequest.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected ExecutePipelineRequest.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
      Specified by:
      newBuilderForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstance

      public static ExecutePipelineRequest getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<ExecutePipelineRequest> parser()

    • getParserForType

      public com.google.protobuf.Parser<ExecutePipelineRequest> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstanceForType

      public ExecutePipelineRequest getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder