Package com.google.firestore.v1

Interface BatchGetDocumentsResponseOrBuilder

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

  • Method Summary

    Modifier and Type
    Method
    Description
    Document
    getFound()
    A document that was requested.
    DocumentOrBuilder
    getFoundOrBuilder()
    A document that was requested.
    String
    getMissing()
    A document name that was requested but does not exist.
    com.google.protobuf.ByteString
    getMissingBytes()
    A document name that was requested but does not exist.
    com.google.protobuf.Timestamp
    getReadTime()
    The time at which the document was read.
    com.google.protobuf.TimestampOrBuilder
    getReadTimeOrBuilder()
    The time at which the document was read.
    BatchGetDocumentsResponse.ResultCase
    getResultCase()
     
    com.google.protobuf.ByteString
    getTransaction()
    The transaction that was started as part of this request.
    boolean
    hasFound()
    A document that was requested.
    boolean
    hasMissing()
    A document name that was requested but does not exist.
    boolean
    hasReadTime()
    The time at which the document was read.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Method Details

    • hasFound

      boolean hasFound()
       A document that was requested.
      .google.firestore.v1.Document found = 1;
      Returns:
      Whether the found field is set.

    • getFound

      Document getFound()
       A document that was requested.
      .google.firestore.v1.Document found = 1;
      Returns:
      The found.

    • getFoundOrBuilder

      DocumentOrBuilder getFoundOrBuilder()
       A document that was requested.
      .google.firestore.v1.Document found = 1;

    • hasMissing

      boolean hasMissing()
       A document name that was requested but does not exist. In the format:
 `projects/{project_id}/databases/{database_id}/documents/{document_path}`.
      string missing = 2;
      Returns:
      Whether the missing field is set.

    • getMissing

      String getMissing()
       A document name that was requested but does not exist. In the format:
 `projects/{project_id}/databases/{database_id}/documents/{document_path}`.
      string missing = 2;
      Returns:
      The missing.

    • getMissingBytes

      com.google.protobuf.ByteString getMissingBytes()
       A document name that was requested but does not exist. In the format:
 `projects/{project_id}/databases/{database_id}/documents/{document_path}`.
      string missing = 2;
      Returns:
      The bytes for missing.

    • getTransaction

      com.google.protobuf.ByteString getTransaction()
       The transaction that was started as part of this request.
 Will only be set in the first response, and only if
 [BatchGetDocumentsRequest.new_transaction][google.firestore.v1.BatchGetDocumentsRequest.new_transaction]
 was set in the request.
      bytes transaction = 3;
      Returns:
      The transaction.

    • hasReadTime

      boolean hasReadTime()
       The time at which the document was read.
 This may be monotically increasing, in this case the previous documents in
 the result stream are guaranteed not to have changed between their
 read_time and this one.
      .google.protobuf.Timestamp read_time = 4;
      Returns:
      Whether the readTime field is set.

    • getReadTime

      com.google.protobuf.Timestamp getReadTime()
       The time at which the document was read.
 This may be monotically increasing, in this case the previous documents in
 the result stream are guaranteed not to have changed between their
 read_time and this one.
      .google.protobuf.Timestamp read_time = 4;
      Returns:
      The readTime.

    • getReadTimeOrBuilder

      com.google.protobuf.TimestampOrBuilder getReadTimeOrBuilder()
       The time at which the document was read.
 This may be monotically increasing, in this case the previous documents in
 the result stream are guaranteed not to have changed between their
 read_time and this one.
      .google.protobuf.Timestamp read_time = 4;

    • getResultCase

      BatchGetDocumentsResponse.ResultCase getResultCase()