Weaviate · Schema

BackupRestoreStatusResponse

The definition of a backup restore metadata.

Vector DatabaseAIMachine LearningSemantic SearchOpen SourceGraphQLKubernetes

Properties

Name Type Description
id string The ID of the backup. Must be URL-safe and work as a filesystem path, only lowercase, numbers, underscore, minus characters allowed.
backend string Backup backend name e.g. filesystem, gcs, s3.
path string Destination path of backup files valid for the selected backup backend, contains bucket and path.
error string Error message if backup restoration failed.
status string Phase of backup restoration process.
View JSON Schema on GitHub

JSON Schema

weaviate-backuprestorestatusresponse-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/BackupRestoreStatusResponse",
  "title": "BackupRestoreStatusResponse",
  "description": "The definition of a backup restore metadata.",
  "properties": {
    "id": {
      "type": "string",
      "description": "The ID of the backup. Must be URL-safe and work as a filesystem path, only lowercase, numbers, underscore, minus characters allowed."
    },
    "backend": {
      "type": "string",
      "description": "Backup backend name e.g. filesystem, gcs, s3."
    },
    "path": {
      "type": "string",
      "description": "Destination path of backup files valid for the selected backup backend, contains bucket and path."
    },
    "error": {
      "type": "string",
      "description": "Error message if backup restoration failed."
    },
    "status": {
      "type": "string",
      "description": "Phase of backup restoration process.",
      "enum": [
        "STARTED",
        "TRANSFERRING",
        "TRANSFERRED",
        "FINALIZING",
        "SUCCESS",
        "FAILED",
        "CANCELLING",
        "CANCELED"
      ],
      "default": "STARTED"
    }
  }
}