Package com.google.firestore.v1

Interface BatchGetDocumentsRequestOrBuilder

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

  • Method Details

    • getDatabase

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

    • getDatabaseBytes

      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];
      Returns:
      The bytes for database.

    • getDocumentsList

      List<String> 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;
      Returns:
      A list containing the documents.

    • getDocumentsCount

      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;
      Returns:
      The count of documents.

    • getDocuments

      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;
      Parameters:
      index - The index of the element to return.
      Returns:
      The documents at the given index.

    • getDocumentsBytes

      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;
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the documents at the given index.

    • hasMask

      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;
      Returns:
      Whether the mask field is set.

    • getMask

      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;
      Returns:
      The mask.

    • getMaskOrBuilder

      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;

    • hasTransaction

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

    • getTransaction

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

    • hasNewTransaction

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

    • getNewTransaction

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

    • getNewTransactionOrBuilder

      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;

    • hasReadTime

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

    • getReadTime

      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;
      Returns:
      The readTime.

    • getReadTimeOrBuilder

      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;

    • getConsistencySelectorCase

      BatchGetDocumentsRequest.ConsistencySelectorCase getConsistencySelectorCase()