Package com.google.firestore.v1

Class BatchGetDocumentsRequest.Builder

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

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

    • clear

      public BatchGetDocumentsRequest.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<BatchGetDocumentsRequest.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<BatchGetDocumentsRequest.Builder>

    • getDefaultInstanceForType

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

    • build

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

    • buildPartial

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

    • clone

      public BatchGetDocumentsRequest.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<BatchGetDocumentsRequest.Builder>

    • setField

      public BatchGetDocumentsRequest.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<BatchGetDocumentsRequest.Builder>

    • clearField

      public BatchGetDocumentsRequest.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<BatchGetDocumentsRequest.Builder>

    • clearOneof

      public BatchGetDocumentsRequest.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<BatchGetDocumentsRequest.Builder>

    • setRepeatedField

      public BatchGetDocumentsRequest.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<BatchGetDocumentsRequest.Builder>

    • addRepeatedField

      public BatchGetDocumentsRequest.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<BatchGetDocumentsRequest.Builder>

    • mergeFrom

      public BatchGetDocumentsRequest.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<BatchGetDocumentsRequest.Builder>

    • mergeFrom

      public BatchGetDocumentsRequest.Builder mergeFrom(BatchGetDocumentsRequest other)

    • isInitialized

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

    • mergeFrom

      public BatchGetDocumentsRequest.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<BatchGetDocumentsRequest.Builder>
      Throws:
      IOException

    • getConsistencySelectorCase

      public BatchGetDocumentsRequest.ConsistencySelectorCase getConsistencySelectorCase()
      Specified by:
      getConsistencySelectorCase in interface BatchGetDocumentsRequestOrBuilder

    • clearConsistencySelector

      public BatchGetDocumentsRequest.Builder clearConsistencySelector()

    • getDatabase

      public String getDatabase()
       Required. The database name. In the format:
 `projects/{project_id}/databases/{database_id}`.
      string database = 1 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getDatabase in interface BatchGetDocumentsRequestOrBuilder
      Returns:
      The database.

    • getDatabaseBytes

      public com.google.protobuf.ByteString getDatabaseBytes()
       Required. The database name. In the format:
 `projects/{project_id}/databases/{database_id}`.
      string database = 1 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getDatabaseBytes in interface BatchGetDocumentsRequestOrBuilder
      Returns:
      The bytes for database.

    • setDatabase

      public BatchGetDocumentsRequest.Builder setDatabase(String value)
       Required. The database name. In the format:
 `projects/{project_id}/databases/{database_id}`.
      string database = 1 [(.google.api.field_behavior) = REQUIRED];
      Parameters:
      value - The database to set.
      Returns:
      This builder for chaining.

    • clearDatabase

      public BatchGetDocumentsRequest.Builder clearDatabase()
       Required. The database name. In the format:
 `projects/{project_id}/databases/{database_id}`.
      string database = 1 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      This builder for chaining.

    • setDatabaseBytes

      public BatchGetDocumentsRequest.Builder setDatabaseBytes(com.google.protobuf.ByteString value)
       Required. The database name. In the format:
 `projects/{project_id}/databases/{database_id}`.
      string database = 1 [(.google.api.field_behavior) = REQUIRED];
      Parameters:
      value - The bytes for database to set.
      Returns:
      This builder for chaining.

    • getDocumentsList

      public com.google.protobuf.ProtocolStringList getDocumentsList()
       The names of the documents to retrieve. In the format:
 `projects/{project_id}/databases/{database_id}/documents/{document_path}`.
 The request will fail if any of the document is not a child resource of the
 given `database`. Duplicate names will be elided.
      repeated string documents = 2;
      Specified by:
      getDocumentsList in interface BatchGetDocumentsRequestOrBuilder
      Returns:
      A list containing the documents.

    • getDocumentsCount

      public int getDocumentsCount()
       The names of the documents to retrieve. In the format:
 `projects/{project_id}/databases/{database_id}/documents/{document_path}`.
 The request will fail if any of the document is not a child resource of the
 given `database`. Duplicate names will be elided.
      repeated string documents = 2;
      Specified by:
      getDocumentsCount in interface BatchGetDocumentsRequestOrBuilder
      Returns:
      The count of documents.

    • getDocuments

      public String getDocuments(int index)
       The names of the documents to retrieve. In the format:
 `projects/{project_id}/databases/{database_id}/documents/{document_path}`.
 The request will fail if any of the document is not a child resource of the
 given `database`. Duplicate names will be elided.
      repeated string documents = 2;
      Specified by:
      getDocuments in interface BatchGetDocumentsRequestOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The documents at the given index.

    • getDocumentsBytes

      public com.google.protobuf.ByteString getDocumentsBytes(int index)
       The names of the documents to retrieve. In the format:
 `projects/{project_id}/databases/{database_id}/documents/{document_path}`.
 The request will fail if any of the document is not a child resource of the
 given `database`. Duplicate names will be elided.
      repeated string documents = 2;
      Specified by:
      getDocumentsBytes in interface BatchGetDocumentsRequestOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the documents at the given index.

    • setDocuments

      public BatchGetDocumentsRequest.Builder setDocuments(int index, String value)
       The names of the documents to retrieve. In the format:
 `projects/{project_id}/databases/{database_id}/documents/{document_path}`.
 The request will fail if any of the document is not a child resource of the
 given `database`. Duplicate names will be elided.
      repeated string documents = 2;
      Parameters:
      index - The index to set the value at.
      value - The documents to set.
      Returns:
      This builder for chaining.

    • addDocuments

      public BatchGetDocumentsRequest.Builder addDocuments(String value)
       The names of the documents to retrieve. In the format:
 `projects/{project_id}/databases/{database_id}/documents/{document_path}`.
 The request will fail if any of the document is not a child resource of the
 given `database`. Duplicate names will be elided.
      repeated string documents = 2;
      Parameters:
      value - The documents to add.
      Returns:
      This builder for chaining.

    • addAllDocuments

      public BatchGetDocumentsRequest.Builder addAllDocuments(Iterable<String> values)
       The names of the documents to retrieve. In the format:
 `projects/{project_id}/databases/{database_id}/documents/{document_path}`.
 The request will fail if any of the document is not a child resource of the
 given `database`. Duplicate names will be elided.
      repeated string documents = 2;
      Parameters:
      values - The documents to add.
      Returns:
      This builder for chaining.

    • clearDocuments

      public BatchGetDocumentsRequest.Builder clearDocuments()
       The names of the documents to retrieve. In the format:
 `projects/{project_id}/databases/{database_id}/documents/{document_path}`.
 The request will fail if any of the document is not a child resource of the
 given `database`. Duplicate names will be elided.
      repeated string documents = 2;
      Returns:
      This builder for chaining.

    • addDocumentsBytes

      public BatchGetDocumentsRequest.Builder addDocumentsBytes(com.google.protobuf.ByteString value)
       The names of the documents to retrieve. In the format:
 `projects/{project_id}/databases/{database_id}/documents/{document_path}`.
 The request will fail if any of the document is not a child resource of the
 given `database`. Duplicate names will be elided.
      repeated string documents = 2;
      Parameters:
      value - The bytes of the documents to add.
      Returns:
      This builder for chaining.

    • hasMask

      public boolean hasMask()
       The fields to return. If not set, returns all fields.

 If a document has a field that is not present in this mask, that field will
 not be returned in the response.
      .google.firestore.v1.DocumentMask mask = 3;
      Specified by:
      hasMask in interface BatchGetDocumentsRequestOrBuilder
      Returns:
      Whether the mask field is set.

    • getMask

      public DocumentMask getMask()
       The fields to return. If not set, returns all fields.

 If a document has a field that is not present in this mask, that field will
 not be returned in the response.
      .google.firestore.v1.DocumentMask mask = 3;
      Specified by:
      getMask in interface BatchGetDocumentsRequestOrBuilder
      Returns:
      The mask.

    • setMask

      public BatchGetDocumentsRequest.Builder setMask(DocumentMask value)
       The fields to return. If not set, returns all fields.

 If a document has a field that is not present in this mask, that field will
 not be returned in the response.
      .google.firestore.v1.DocumentMask mask = 3;

    • setMask

      public BatchGetDocumentsRequest.Builder setMask(DocumentMask.Builder builderForValue)
       The fields to return. If not set, returns all fields.

 If a document has a field that is not present in this mask, that field will
 not be returned in the response.
      .google.firestore.v1.DocumentMask mask = 3;

    • mergeMask

      public BatchGetDocumentsRequest.Builder mergeMask(DocumentMask value)
       The fields to return. If not set, returns all fields.

 If a document has a field that is not present in this mask, that field will
 not be returned in the response.
      .google.firestore.v1.DocumentMask mask = 3;

    • clearMask

      public BatchGetDocumentsRequest.Builder clearMask()
       The fields to return. If not set, returns all fields.

 If a document has a field that is not present in this mask, that field will
 not be returned in the response.
      .google.firestore.v1.DocumentMask mask = 3;

    • getMaskBuilder

      public DocumentMask.Builder getMaskBuilder()
       The fields to return. If not set, returns all fields.

 If a document has a field that is not present in this mask, that field will
 not be returned in the response.
      .google.firestore.v1.DocumentMask mask = 3;

    • getMaskOrBuilder

      public DocumentMaskOrBuilder getMaskOrBuilder()
       The fields to return. If not set, returns all fields.

 If a document has a field that is not present in this mask, that field will
 not be returned in the response.
      .google.firestore.v1.DocumentMask mask = 3;
      Specified by:
      getMaskOrBuilder in interface BatchGetDocumentsRequestOrBuilder

    • hasTransaction

      public boolean hasTransaction()
       Reads documents in a transaction.
      bytes transaction = 4;
      Specified by:
      hasTransaction in interface BatchGetDocumentsRequestOrBuilder
      Returns:
      Whether the transaction field is set.

    • getTransaction

      public com.google.protobuf.ByteString getTransaction()
       Reads documents in a transaction.
      bytes transaction = 4;
      Specified by:
      getTransaction in interface BatchGetDocumentsRequestOrBuilder
      Returns:
      The transaction.

    • setTransaction

      public BatchGetDocumentsRequest.Builder setTransaction(com.google.protobuf.ByteString value)
       Reads documents in a transaction.
      bytes transaction = 4;
      Parameters:
      value - The transaction to set.
      Returns:
      This builder for chaining.

    • clearTransaction

      public BatchGetDocumentsRequest.Builder clearTransaction()
       Reads documents in a transaction.
      bytes transaction = 4;
      Returns:
      This builder for chaining.

    • hasNewTransaction

      public boolean hasNewTransaction()
       Starts a new transaction and reads the documents.
 Defaults to a read-only transaction.
 The new transaction ID will be returned as the first response in the
 stream.
      .google.firestore.v1.TransactionOptions new_transaction = 5;
      Specified by:
      hasNewTransaction in interface BatchGetDocumentsRequestOrBuilder
      Returns:
      Whether the newTransaction field is set.

    • getNewTransaction

      public TransactionOptions getNewTransaction()
       Starts a new transaction and reads the documents.
 Defaults to a read-only transaction.
 The new transaction ID will be returned as the first response in the
 stream.
      .google.firestore.v1.TransactionOptions new_transaction = 5;
      Specified by:
      getNewTransaction in interface BatchGetDocumentsRequestOrBuilder
      Returns:
      The newTransaction.

    • setNewTransaction

      public BatchGetDocumentsRequest.Builder setNewTransaction(TransactionOptions value)
       Starts a new transaction and reads the documents.
 Defaults to a read-only transaction.
 The new transaction ID will be returned as the first response in the
 stream.
      .google.firestore.v1.TransactionOptions new_transaction = 5;

    • setNewTransaction

      public BatchGetDocumentsRequest.Builder setNewTransaction(TransactionOptions.Builder builderForValue)
       Starts a new transaction and reads the documents.
 Defaults to a read-only transaction.
 The new transaction ID will be returned as the first response in the
 stream.
      .google.firestore.v1.TransactionOptions new_transaction = 5;

    • mergeNewTransaction

      public BatchGetDocumentsRequest.Builder mergeNewTransaction(TransactionOptions value)
       Starts a new transaction and reads the documents.
 Defaults to a read-only transaction.
 The new transaction ID will be returned as the first response in the
 stream.
      .google.firestore.v1.TransactionOptions new_transaction = 5;

    • clearNewTransaction

      public BatchGetDocumentsRequest.Builder clearNewTransaction()
       Starts a new transaction and reads the documents.
 Defaults to a read-only transaction.
 The new transaction ID will be returned as the first response in the
 stream.
      .google.firestore.v1.TransactionOptions new_transaction = 5;

    • getNewTransactionBuilder

      public TransactionOptions.Builder getNewTransactionBuilder()
       Starts a new transaction and reads the documents.
 Defaults to a read-only transaction.
 The new transaction ID will be returned as the first response in the
 stream.
      .google.firestore.v1.TransactionOptions new_transaction = 5;

    • getNewTransactionOrBuilder

      public TransactionOptionsOrBuilder getNewTransactionOrBuilder()
       Starts a new transaction and reads the documents.
 Defaults to a read-only transaction.
 The new transaction ID will be returned as the first response in the
 stream.
      .google.firestore.v1.TransactionOptions new_transaction = 5;
      Specified by:
      getNewTransactionOrBuilder in interface BatchGetDocumentsRequestOrBuilder

    • hasReadTime

      public boolean hasReadTime()
       Reads documents as they were 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 BatchGetDocumentsRequestOrBuilder
      Returns:
      Whether the readTime field is set.

    • getReadTime

      public com.google.protobuf.Timestamp getReadTime()
       Reads documents as they were 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 BatchGetDocumentsRequestOrBuilder
      Returns:
      The readTime.

    • setReadTime

      public BatchGetDocumentsRequest.Builder setReadTime(com.google.protobuf.Timestamp value)
       Reads documents as they were 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 BatchGetDocumentsRequest.Builder setReadTime(com.google.protobuf.Timestamp.Builder builderForValue)
       Reads documents as they were 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 BatchGetDocumentsRequest.Builder mergeReadTime(com.google.protobuf.Timestamp value)
       Reads documents as they were 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 BatchGetDocumentsRequest.Builder clearReadTime()
       Reads documents as they were 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()
       Reads documents as they were 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()
       Reads documents as they were 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 BatchGetDocumentsRequestOrBuilder

    • setUnknownFields

      public final BatchGetDocumentsRequest.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<BatchGetDocumentsRequest.Builder>

    • mergeUnknownFields

      public final BatchGetDocumentsRequest.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<BatchGetDocumentsRequest.Builder>