View Source GoogleApi.Firestore.V1.Model.GoogleFirestoreAdminV1BulkDeleteDocumentsMetadata (google_api_firestore v0.29.0)

Metadata for google.longrunning.Operation results from FirestoreAdmin.BulkDeleteDocuments.

Attributes

  • collectionIds (type: list(String.t), default: nil) - The ids of the collection groups that are being deleted.
  • endTime (type: DateTime.t, default: nil) - The time this operation completed. Will be unset if operation still in progress.
  • namespaceIds (type: list(String.t), default: nil) - Which namespace ids are being deleted.
  • operationState (type: String.t, default: nil) - The state of the operation.
  • progressBytes (type: GoogleApi.Firestore.V1.Model.GoogleFirestoreAdminV1Progress.t, default: nil) - The progress, in bytes, of this operation.
  • progressDocuments (type: GoogleApi.Firestore.V1.Model.GoogleFirestoreAdminV1Progress.t, default: nil) - The progress, in documents, of this operation.
  • snapshotTime (type: DateTime.t, default: nil) - 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).
  • startTime (type: DateTime.t, default: nil) - The time this operation started.

Summary

Functions

Unwrap a decoded JSON object into its complex fields.

Types

@type t() ::
  %GoogleApi.Firestore.V1.Model.GoogleFirestoreAdminV1BulkDeleteDocumentsMetadata{
    collectionIds: [String.t()] | nil,
    endTime: DateTime.t() | nil,
    namespaceIds: [String.t()] | nil,
    operationState: String.t() | nil,
    progressBytes:
      GoogleApi.Firestore.V1.Model.GoogleFirestoreAdminV1Progress.t() | nil,
    progressDocuments:
      GoogleApi.Firestore.V1.Model.GoogleFirestoreAdminV1Progress.t() | nil,
    snapshotTime: DateTime.t() | nil,
    startTime: DateTime.t() | nil
  }

Functions

@spec decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.