Package com.google.firestore.bundle

Interface BundleMetadataOrBuilder

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

  • Method Summary

    Modifier and Type
    Method
    Description
    com.google.protobuf.Timestamp
    getCreateTime()
    Time at which the documents snapshot is taken for this bundle.
    com.google.protobuf.TimestampOrBuilder
    getCreateTimeOrBuilder()
    Time at which the documents snapshot is taken for this bundle.
    String
    getId()
    The ID of the bundle.
    com.google.protobuf.ByteString
    getIdBytes()
    The ID of the bundle.
    long
    getTotalBytes()
    The size of the bundle in bytes, excluding this `BundleMetadata`.
    int
    getTotalDocuments()
    The number of documents in the bundle.
    int
    getVersion()
    The schema version of the bundle.
    boolean
    hasCreateTime()
    Time at which the documents snapshot is taken for this bundle.

    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

    • getId

      String getId()
       The ID of the bundle.
      string id = 1;
      Returns:
      The id.

    • getIdBytes

      com.google.protobuf.ByteString getIdBytes()
       The ID of the bundle.
      string id = 1;
      Returns:
      The bytes for id.

    • hasCreateTime

      boolean hasCreateTime()
       Time at which the documents snapshot is taken for this bundle.
      .google.protobuf.Timestamp create_time = 2;
      Returns:
      Whether the createTime field is set.

    • getCreateTime

      com.google.protobuf.Timestamp getCreateTime()
       Time at which the documents snapshot is taken for this bundle.
      .google.protobuf.Timestamp create_time = 2;
      Returns:
      The createTime.

    • getCreateTimeOrBuilder

      com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
       Time at which the documents snapshot is taken for this bundle.
      .google.protobuf.Timestamp create_time = 2;

    • getVersion

      int getVersion()
       The schema version of the bundle.
      uint32 version = 3;
      Returns:
      The version.

    • getTotalDocuments

      int getTotalDocuments()
       The number of documents in the bundle.
      uint32 total_documents = 4;
      Returns:
      The totalDocuments.

    • getTotalBytes

      long getTotalBytes()
       The size of the bundle in bytes, excluding this `BundleMetadata`.
      uint64 total_bytes = 5;
      Returns:
      The totalBytes.