Package com.google.firestore.v1

Class ExecutePipelineRequest.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessageV3.Builder<ExecutePipelineRequest.Builder>
com.google.firestore.v1.ExecutePipelineRequest.Builder
All Implemented Interfaces:
ExecutePipelineRequestOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
ExecutePipelineRequest
public static final class ExecutePipelineRequest.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<ExecutePipelineRequest.Builder> implements ExecutePipelineRequestOrBuilder
 The request for
 [Firestore.ExecutePipeline][google.firestore.v1.Firestore.ExecutePipeline].
Protobuf type google.firestore.v1.ExecutePipelineRequest

  • Method Details

    • 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.Builder<ExecutePipelineRequest.Builder>

    • clear

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

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<ExecutePipelineRequest.Builder>

    • getDefaultInstanceForType

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

    • build

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

    • buildPartial

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

    • clone

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

    • setField

      public ExecutePipelineRequest.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
      Specified by:
      setField in interface com.google.protobuf.Message.Builder
      Overrides:
      setField in class com.google.protobuf.GeneratedMessageV3.Builder<ExecutePipelineRequest.Builder>

    • clearField

      public ExecutePipelineRequest.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
      Specified by:
      clearField in interface com.google.protobuf.Message.Builder
      Overrides:
      clearField in class com.google.protobuf.GeneratedMessageV3.Builder<ExecutePipelineRequest.Builder>

    • clearOneof

      public ExecutePipelineRequest.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
      Specified by:
      clearOneof in interface com.google.protobuf.Message.Builder
      Overrides:
      clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<ExecutePipelineRequest.Builder>

    • setRepeatedField

      public ExecutePipelineRequest.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
      Specified by:
      setRepeatedField in interface com.google.protobuf.Message.Builder
      Overrides:
      setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<ExecutePipelineRequest.Builder>

    • addRepeatedField

      public ExecutePipelineRequest.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
      Specified by:
      addRepeatedField in interface com.google.protobuf.Message.Builder
      Overrides:
      addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<ExecutePipelineRequest.Builder>

    • mergeFrom

      public ExecutePipelineRequest.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<ExecutePipelineRequest.Builder>

    • mergeFrom

      public ExecutePipelineRequest.Builder mergeFrom(ExecutePipelineRequest other)

    • isInitialized

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

    • mergeFrom

      public ExecutePipelineRequest.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<ExecutePipelineRequest.Builder>
      Throws:
      IOException

    • getPipelineTypeCase

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

    • clearPipelineType

      public ExecutePipelineRequest.Builder clearPipelineType()

    • getConsistencySelectorCase

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

    • clearConsistencySelector

      public ExecutePipelineRequest.Builder clearConsistencySelector()

    • 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.

    • setDatabase

      public ExecutePipelineRequest.Builder setDatabase(String value)
       Required. Database identifier, in the form
 `projects/{project}/databases/{database}`.
      string database = 1 [(.google.api.field_behavior) = REQUIRED];
      Parameters:
      value - The database to set.
      Returns:
      This builder for chaining.

    • clearDatabase

      public ExecutePipelineRequest.Builder clearDatabase()
       Required. Database identifier, in the form
 `projects/{project}/databases/{database}`.
      string database = 1 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      This builder for chaining.

    • setDatabaseBytes

      public ExecutePipelineRequest.Builder setDatabaseBytes(com.google.protobuf.ByteString value)
       Required. Database identifier, in the form
 `projects/{project}/databases/{database}`.
      string database = 1 [(.google.api.field_behavior) = REQUIRED];
      Parameters:
      value - The bytes for database to set.
      Returns:
      This builder for chaining.

    • 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.

    • setStructuredPipeline

      public ExecutePipelineRequest.Builder setStructuredPipeline(StructuredPipeline value)
       A pipelined operation.
      .google.firestore.v1.StructuredPipeline structured_pipeline = 2;

    • setStructuredPipeline

      public ExecutePipelineRequest.Builder setStructuredPipeline(StructuredPipeline.Builder builderForValue)
       A pipelined operation.
      .google.firestore.v1.StructuredPipeline structured_pipeline = 2;

    • mergeStructuredPipeline

      public ExecutePipelineRequest.Builder mergeStructuredPipeline(StructuredPipeline value)
       A pipelined operation.
      .google.firestore.v1.StructuredPipeline structured_pipeline = 2;

    • clearStructuredPipeline

      public ExecutePipelineRequest.Builder clearStructuredPipeline()
       A pipelined operation.
      .google.firestore.v1.StructuredPipeline structured_pipeline = 2;

    • getStructuredPipelineBuilder

      public StructuredPipeline.Builder getStructuredPipelineBuilder()
       A pipelined operation.
      .google.firestore.v1.StructuredPipeline structured_pipeline = 2;

    • 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.

    • setTransaction

      public ExecutePipelineRequest.Builder setTransaction(com.google.protobuf.ByteString value)
       Run the query within an already active transaction.

 The value here is the opaque transaction ID to execute the query in.
      bytes transaction = 5;
      Parameters:
      value - The transaction to set.
      Returns:
      This builder for chaining.

    • clearTransaction

      public ExecutePipelineRequest.Builder clearTransaction()
       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:
      This builder for chaining.

    • 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.

    • setNewTransaction

      public ExecutePipelineRequest.Builder setNewTransaction(TransactionOptions value)
       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;

    • setNewTransaction

      public ExecutePipelineRequest.Builder setNewTransaction(TransactionOptions.Builder builderForValue)
       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;

    • mergeNewTransaction

      public ExecutePipelineRequest.Builder mergeNewTransaction(TransactionOptions value)
       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;

    • clearNewTransaction

      public ExecutePipelineRequest.Builder clearNewTransaction()
       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;

    • getNewTransactionBuilder

      public TransactionOptions.Builder getNewTransactionBuilder()
       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;

    • 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.

    • setReadTime

      public ExecutePipelineRequest.Builder setReadTime(com.google.protobuf.Timestamp value)
       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;

    • setReadTime

      public ExecutePipelineRequest.Builder setReadTime(com.google.protobuf.Timestamp.Builder builderForValue)
       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;

    • mergeReadTime

      public ExecutePipelineRequest.Builder mergeReadTime(com.google.protobuf.Timestamp value)
       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;

    • clearReadTime

      public ExecutePipelineRequest.Builder clearReadTime()
       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;

    • getReadTimeBuilder

      public com.google.protobuf.Timestamp.Builder getReadTimeBuilder()
       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;

    • 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

    • setUnknownFields

      public final ExecutePipelineRequest.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
      Specified by:
      setUnknownFields in interface com.google.protobuf.Message.Builder
      Overrides:
      setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<ExecutePipelineRequest.Builder>

    • mergeUnknownFields

      public final ExecutePipelineRequest.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
      Specified by:
      mergeUnknownFields in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<ExecutePipelineRequest.Builder>