Package com.google.firestore.admin.v1

Interface BulkDeleteDocumentsMetadataOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
BulkDeleteDocumentsMetadata, BulkDeleteDocumentsMetadata.Builder
@Generated public interface BulkDeleteDocumentsMetadataOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getCollectionIds(int index)
    The IDs of the collection groups that are being deleted.
    com.google.protobuf.ByteString
    getCollectionIdsBytes(int index)
    The IDs of the collection groups that are being deleted.
    int
    getCollectionIdsCount()
    The IDs of the collection groups that are being deleted.
    List<String>
    getCollectionIdsList()
    The IDs of the collection groups that are being deleted.
    com.google.protobuf.Timestamp
    getEndTime()
    The time this operation completed.
    com.google.protobuf.TimestampOrBuilder
    getEndTimeOrBuilder()
    The time this operation completed.
    String
    getNamespaceIds(int index)
    Which namespace IDs are being deleted.
    com.google.protobuf.ByteString
    getNamespaceIdsBytes(int index)
    Which namespace IDs are being deleted.
    int
    getNamespaceIdsCount()
    Which namespace IDs are being deleted.
    List<String>
    getNamespaceIdsList()
    Which namespace IDs are being deleted.
    OperationState
    getOperationState()
    The state of the operation.
    int
    getOperationStateValue()
    The state of the operation.
    Progress
    getProgressBytes()
    The progress, in bytes, of this operation.
    ProgressOrBuilder
    getProgressBytesOrBuilder()
    The progress, in bytes, of this operation.
    Progress
    getProgressDocuments()
    The progress, in documents, of this operation.
    ProgressOrBuilder
    getProgressDocumentsOrBuilder()
    The progress, in documents, of this operation.
    com.google.protobuf.Timestamp
    getSnapshotTime()
    The timestamp that corresponds to the version of the database that is being read to get the list of documents to delete.
    com.google.protobuf.TimestampOrBuilder
    getSnapshotTimeOrBuilder()
    The timestamp that corresponds to the version of the database that is being read to get the list of documents to delete.
    com.google.protobuf.Timestamp
    getStartTime()
    The time this operation started.
    com.google.protobuf.TimestampOrBuilder
    getStartTimeOrBuilder()
    The time this operation started.
    boolean
    hasEndTime()
    The time this operation completed.
    boolean
    hasProgressBytes()
    The progress, in bytes, of this operation.
    boolean
    hasProgressDocuments()
    The progress, in documents, of this operation.
    boolean
    hasSnapshotTime()
    The timestamp that corresponds to the version of the database that is being read to get the list of documents to delete.
    boolean
    hasStartTime()
    The time this operation started.

    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

    • hasStartTime

      boolean hasStartTime()
       The time this operation started.
      .google.protobuf.Timestamp start_time = 1;
      Returns:
      Whether the startTime field is set.

    • getStartTime

      com.google.protobuf.Timestamp getStartTime()
       The time this operation started.
      .google.protobuf.Timestamp start_time = 1;
      Returns:
      The startTime.

    • getStartTimeOrBuilder

      com.google.protobuf.TimestampOrBuilder getStartTimeOrBuilder()
       The time this operation started.
      .google.protobuf.Timestamp start_time = 1;

    • hasEndTime

      boolean hasEndTime()
       The time this operation completed. Will be unset if operation still in
 progress.
      .google.protobuf.Timestamp end_time = 2;
      Returns:
      Whether the endTime field is set.

    • getEndTime

      com.google.protobuf.Timestamp getEndTime()
       The time this operation completed. Will be unset if operation still in
 progress.
      .google.protobuf.Timestamp end_time = 2;
      Returns:
      The endTime.

    • getEndTimeOrBuilder

      com.google.protobuf.TimestampOrBuilder getEndTimeOrBuilder()
       The time this operation completed. Will be unset if operation still in
 progress.
      .google.protobuf.Timestamp end_time = 2;

    • getOperationStateValue

      int getOperationStateValue()
       The state of the operation.
      .google.firestore.admin.v1.OperationState operation_state = 3;
      Returns:
      The enum numeric value on the wire for operationState.

    • getOperationState

      OperationState getOperationState()
       The state of the operation.
      .google.firestore.admin.v1.OperationState operation_state = 3;
      Returns:
      The operationState.

    • hasProgressDocuments

      boolean hasProgressDocuments()
       The progress, in documents, of this operation.
      .google.firestore.admin.v1.Progress progress_documents = 4;
      Returns:
      Whether the progressDocuments field is set.

    • getProgressDocuments

      Progress getProgressDocuments()
       The progress, in documents, of this operation.
      .google.firestore.admin.v1.Progress progress_documents = 4;
      Returns:
      The progressDocuments.

    • getProgressDocumentsOrBuilder

      ProgressOrBuilder getProgressDocumentsOrBuilder()
       The progress, in documents, of this operation.
      .google.firestore.admin.v1.Progress progress_documents = 4;

    • hasProgressBytes

      boolean hasProgressBytes()
       The progress, in bytes, of this operation.
      .google.firestore.admin.v1.Progress progress_bytes = 5;
      Returns:
      Whether the progressBytes field is set.

    • getProgressBytes

      Progress getProgressBytes()
       The progress, in bytes, of this operation.
      .google.firestore.admin.v1.Progress progress_bytes = 5;
      Returns:
      The progressBytes.

    • getProgressBytesOrBuilder

      ProgressOrBuilder getProgressBytesOrBuilder()
       The progress, in bytes, of this operation.
      .google.firestore.admin.v1.Progress progress_bytes = 5;

    • getCollectionIdsList

      List<String> getCollectionIdsList()
       The IDs of the collection groups that are being deleted.
      repeated string collection_ids = 6;
      Returns:
      A list containing the collectionIds.

    • getCollectionIdsCount

      int getCollectionIdsCount()
       The IDs of the collection groups that are being deleted.
      repeated string collection_ids = 6;
      Returns:
      The count of collectionIds.

    • getCollectionIds

      String getCollectionIds(int index)
       The IDs of the collection groups that are being deleted.
      repeated string collection_ids = 6;
      Parameters:
      index - The index of the element to return.
      Returns:
      The collectionIds at the given index.

    • getCollectionIdsBytes

      com.google.protobuf.ByteString getCollectionIdsBytes(int index)
       The IDs of the collection groups that are being deleted.
      repeated string collection_ids = 6;
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the collectionIds at the given index.

    • getNamespaceIdsList

      List<String> getNamespaceIdsList()
       Which namespace IDs are being deleted.
      repeated string namespace_ids = 7;
      Returns:
      A list containing the namespaceIds.

    • getNamespaceIdsCount

      int getNamespaceIdsCount()
       Which namespace IDs are being deleted.
      repeated string namespace_ids = 7;
      Returns:
      The count of namespaceIds.

    • getNamespaceIds

      String getNamespaceIds(int index)
       Which namespace IDs are being deleted.
      repeated string namespace_ids = 7;
      Parameters:
      index - The index of the element to return.
      Returns:
      The namespaceIds at the given index.

    • getNamespaceIdsBytes

      com.google.protobuf.ByteString getNamespaceIdsBytes(int index)
       Which namespace IDs are being deleted.
      repeated string namespace_ids = 7;
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the namespaceIds at the given index.

    • hasSnapshotTime

      boolean hasSnapshotTime()
       The timestamp that corresponds to the version of the database that is being
 read to get the list of documents to delete. This time can also be used as
 the timestamp of PITR in case of disaster recovery (subject to PITR window
 limit).
      .google.protobuf.Timestamp snapshot_time = 8;
      Returns:
      Whether the snapshotTime field is set.

    • getSnapshotTime

      com.google.protobuf.Timestamp getSnapshotTime()
       The timestamp that corresponds to the version of the database that is being
 read to get the list of documents to delete. This time can also be used as
 the timestamp of PITR in case of disaster recovery (subject to PITR window
 limit).
      .google.protobuf.Timestamp snapshot_time = 8;
      Returns:
      The snapshotTime.

    • getSnapshotTimeOrBuilder

      com.google.protobuf.TimestampOrBuilder getSnapshotTimeOrBuilder()
       The timestamp that corresponds to the version of the database that is being
 read to get the list of documents to delete. This time can also be used as
 the timestamp of PITR in case of disaster recovery (subject to PITR window
 limit).
      .google.protobuf.Timestamp snapshot_time = 8;