View Source GoogleApi.Firestore.V1.Model.GoogleFirestoreAdminV1ExportDocumentsRequest (google_api_firestore v0.27.0)

The request for FirestoreAdmin.ExportDocuments.

Attributes

collectionIds (type: list(String.t), default: nil) - Which collection ids to export. Unspecified means all collections.
namespaceIds (type: list(String.t), default: nil) - An empty list represents all namespaces. This is the preferred usage for databases that don't use namespaces. An empty string element represents the default namespace. This should be used if the database has data in non-default namespaces, but doesn't want to include them. Each namespace in this list must be unique.
outputUriPrefix (type: String.t, default: nil) - The output URI. Currently only supports Google Cloud Storage URIs of the form: gs://BUCKET_NAME[/NAMESPACE_PATH], where BUCKET_NAME is the name of the Google Cloud Storage bucket and NAMESPACE_PATH is an optional Google Cloud Storage namespace path. When choosing a name, be sure to consider Google Cloud Storage naming guidelines: https://cloud.google.com/storage/docs/naming. If the URI is a bucket (without a namespace path), a prefix will be generated based on the start time.
snapshotTime (type: DateTime.t, default: nil) - The timestamp that corresponds to the version of the database to be exported. The timestamp must be in the past, rounded to the minute and not older than earliestVersionTime. If specified, then the exported documents will represent a consistent view of the database at the provided time. Otherwise, there are no guarantees about the consistency of the exported documents.

Summary

Types

t()

Functions

decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() ::
  %GoogleApi.Firestore.V1.Model.GoogleFirestoreAdminV1ExportDocumentsRequest{
    collectionIds: [String.t()] | nil,
    namespaceIds: [String.t()] | nil,
    outputUriPrefix: String.t() | nil,
    snapshotTime: DateTime.t() | nil
  }

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.