Package com.google.firestore.bundle

Interface BundledDocumentMetadataOrBuilder

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

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    getExists()
    Whether the document exists.
    String
    getName()
    The document key of a bundled document.
    com.google.protobuf.ByteString
    getNameBytes()
    The document key of a bundled document.
    String
    getQueries(int index)
    The names of the queries in this bundle that this document matches to.
    com.google.protobuf.ByteString
    getQueriesBytes(int index)
    The names of the queries in this bundle that this document matches to.
    int
    getQueriesCount()
    The names of the queries in this bundle that this document matches to.
    List<String>
    getQueriesList()
    The names of the queries in this bundle that this document matches to.
    com.google.protobuf.Timestamp
    getReadTime()
    The snapshot version of the document data bundled.
    com.google.protobuf.TimestampOrBuilder
    getReadTimeOrBuilder()
    The snapshot version of the document data bundled.
    boolean
    hasReadTime()
    The snapshot version of the document data bundled.

    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

    • getName

      String getName()
       The document key of a bundled document.
      string name = 1;
      Returns:
      The name.

    • getNameBytes

      com.google.protobuf.ByteString getNameBytes()
       The document key of a bundled document.
      string name = 1;
      Returns:
      The bytes for name.

    • hasReadTime

      boolean hasReadTime()
       The snapshot version of the document data bundled.
      .google.protobuf.Timestamp read_time = 2;
      Returns:
      Whether the readTime field is set.

    • getReadTime

      com.google.protobuf.Timestamp getReadTime()
       The snapshot version of the document data bundled.
      .google.protobuf.Timestamp read_time = 2;
      Returns:
      The readTime.

    • getReadTimeOrBuilder

      com.google.protobuf.TimestampOrBuilder getReadTimeOrBuilder()
       The snapshot version of the document data bundled.
      .google.protobuf.Timestamp read_time = 2;

    • getExists

      boolean getExists()
       Whether the document exists.
      bool exists = 3;
      Returns:
      The exists.

    • getQueriesList

      List<String> getQueriesList()
       The names of the queries in this bundle that this document matches to.
      repeated string queries = 4;
      Returns:
      A list containing the queries.

    • getQueriesCount

      int getQueriesCount()
       The names of the queries in this bundle that this document matches to.
      repeated string queries = 4;
      Returns:
      The count of queries.

    • getQueries

      String getQueries(int index)
       The names of the queries in this bundle that this document matches to.
      repeated string queries = 4;
      Parameters:
      index - The index of the element to return.
      Returns:
      The queries at the given index.

    • getQueriesBytes

      com.google.protobuf.ByteString getQueriesBytes(int index)
       The names of the queries in this bundle that this document matches to.
      repeated string queries = 4;
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the queries at the given index.