Weaviate · JSON Structure

Weaviate Backup Create Response Structure

The definition of a backup create response body

Type: object Properties: 7
Vector DatabaseAIMachine LearningSemantic SearchOpen SourceGraphQLKubernetes

Weaviate Backup Create Response Structure is a JSON Structure definition published by Weaviate, describing 7 properties. It conforms to the https://json-structure.org/meta/extended/v0/# meta-schema.

Properties

id classes backend bucket path error status

Meta-schema: https://json-structure.org/meta/extended/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/extended/v0/#",
  "$id": "https://api-evangelist.github.io/weaviate/json-structure/weaviate-backup-create-response-structure.json",
  "title": "BackupCreateResponse",
  "description": "The definition of a backup create response body",
  "type": "object",
  "properties": {
    "id": {
      "type": "str",
      "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."
    },
    "backend": {
      "type": "str",
      "description": "Backup backend name e.g. filesystem, gcs, s3."
    },
    "bucket": {
      "type": "str",
      "description": "Name of the bucket, container, volume, etc"
    },
    "path": {
      "type": "str",
      "description": "Path within bucket of backup"
    },
    "error": {
      "type": "str",
      "description": "error message if creation failed"
    },
    "status": {
      "type": "str",
      "description": "phase of backup creation process"
    }
  }
}