Weaviate · Schema

BackupRestoreResponse

The definition of a backup restore response body.

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.
classes	array	The list of collections (classes) for which the backup restoration process was started.
backend	string	Backup backend name e.g. filesystem, gcs, s3.
path	string	Destination path of backup files valid for the selected backend.
error	string	Error message if backup restoration failed.
status	string	Phase of backup restoration process.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/BackupRestoreResponse",
  "title": "BackupRestoreResponse",
  "description": "The definition of a backup restore response body.",
  "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."
    },
    "classes": {
      "type": "array",
      "description": "The list of collections (classes) for which the backup restoration process was started.",
      "items": {
        "type": "string"
      }
    },
    "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 backend."
    },
    "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"
    }
  }
}