Package com.google.firestore.v1

Class BatchGetDocumentsRequest

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

  • Field Details

  • 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

    • getConsistencySelectorCase

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

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

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

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

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

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

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

    • 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

    • 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 BatchGetDocumentsRequest parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static BatchGetDocumentsRequest.Builder newBuilder()

    • newBuilder

      public static BatchGetDocumentsRequest.Builder newBuilder(BatchGetDocumentsRequest prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static BatchGetDocumentsRequest getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<BatchGetDocumentsRequest> 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 BatchGetDocumentsRequest getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder