Weaviate · Schema

BackupCreateResponse

The definition of a backup create 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 creation process was started.
backend string Backup backend name e.g. filesystem, gcs, s3.
bucket string Name of the bucket, container, volume, etc
path string Path within bucket of backup
error string error message if creation failed
status string phase of backup creation process
View JSON Schema on GitHub

JSON Schema

weaviate-backup-create-response-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://api-evangelist.github.io/weaviate/json-schema/weaviate-backup-create-response-schema.json",
  "title": "BackupCreateResponse",
  "description": "The definition of a backup create response body",
  "type": "object",
  "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 creation process was started.",
      "items": {
        "type": "string"
      }
    },
    "backend": {
      "type": "string",
      "description": "Backup backend name e.g. filesystem, gcs, s3."
    },
    "bucket": {
      "type": "string",
      "description": "Name of the bucket, container, volume, etc"
    },
    "path": {
      "type": "string",
      "description": "Path within bucket of backup"
    },
    "error": {
      "type": "string",
      "description": "error message if creation failed"
    },
    "status": {
      "type": "string",
      "description": "phase of backup creation process",
      "enum": [
        "STARTED",
        "TRANSFERRING",
        "TRANSFERRED",
        "FINALIZING",
        "SUCCESS",
        "FAILED",
        "CANCELLING",
        "CANCELED"
      ],
      "default": "STARTED"
    }
  }
}