datadownload_v2alpha1.json

{
  "description": "DataDownload acts as the protocol between data mover plugins and data mover controller for the datamover restore operation",
  "properties": {
    "apiVersion": {
      "description": "APIVersion defines the versioned schema of this representation of an object.\nServers should convert recognized schemas to the latest internal value, and\nmay reject unrecognized values.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources",
      "type": "string"
    },
    "kind": {
      "description": "Kind is a string value representing the REST resource this object represents.\nServers may infer this from the endpoint the client submits requests to.\nCannot be updated.\nIn CamelCase.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds",
      "type": "string"
    },
    "metadata": {
      "type": "object"
    },
    "spec": {
      "description": "DataDownloadSpec is the specification for a DataDownload.",
      "properties": {
        "backupStorageLocation": {
          "description": "BackupStorageLocation is the name of the backup storage location\nwhere the backup repository is stored.",
          "type": "string"
        },
        "cancel": {
          "description": "Cancel indicates request to cancel the ongoing DataDownload. It can be set\nwhen the DataDownload is in InProgress phase",
          "type": "boolean"
        },
        "dataMoverConfig": {
          "additionalProperties": {
            "type": "string"
          },
          "description": "DataMoverConfig is for data-mover-specific configuration fields.",
          "type": "object"
        },
        "datamover": {
          "description": "DataMover specifies the data mover to be used by the backup.\nIf DataMover is \"\" or \"velero\", the built-in data mover will be used.",
          "type": "string"
        },
        "operationTimeout": {
          "description": "OperationTimeout specifies the time used to wait internal operations,\nbefore returning error as timeout.",
          "type": "string"
        },
        "snapshotID": {
          "description": "SnapshotID is the ID of the Velero backup snapshot to be restored from.",
          "type": "string"
        },
        "sourceNamespace": {
          "description": "SourceNamespace is the original namespace where the volume is backed up from.\nIt may be different from SourcePVC's namespace if namespace is remapped during restore.",
          "type": "string"
        },
        "targetVolume": {
          "description": "TargetVolume is the information of the target PVC and PV.",
          "properties": {
            "namespace": {
              "description": "Namespace is the target namespace",
              "type": "string"
            },
            "pv": {
              "description": "PV is the name of the target PV that is created by Velero restore",
              "type": "string"
            },
            "pvc": {
              "description": "PVC is the name of the target PVC that is created by Velero restore",
              "type": "string"
            }
          },
          "required": [
            "namespace",
            "pv",
            "pvc"
          ],
          "type": "object",
          "additionalProperties": false
        }
      },
      "required": [
        "backupStorageLocation",
        "operationTimeout",
        "snapshotID",
        "sourceNamespace",
        "targetVolume"
      ],
      "type": "object",
      "additionalProperties": false
    },
    "status": {
      "description": "DataDownloadStatus is the current status of a DataDownload.",
      "properties": {
        "completionTimestamp": {
          "description": "CompletionTimestamp records the time a restore was completed.\nCompletion time is recorded even on failed restores.\nThe server's time is used for CompletionTimestamps",
          "format": "date-time",
          "nullable": true,
          "type": "string"
        },
        "message": {
          "description": "Message is a message about the DataDownload's status.",
          "type": "string"
        },
        "node": {
          "description": "Node is name of the node where the DataDownload is processed.",
          "type": "string"
        },
        "phase": {
          "description": "Phase is the current state of the DataDownload.",
          "enum": [
            "New",
            "Accepted",
            "Prepared",
            "InProgress",
            "Canceling",
            "Canceled",
            "Completed",
            "Failed"
          ],
          "type": "string"
        },
        "progress": {
          "description": "Progress holds the total number of bytes of the snapshot and the current\nnumber of restored bytes. This can be used to display progress information\nabout the restore operation.",
          "properties": {
            "bytesDone": {
              "format": "int64",
              "type": "integer"
            },
            "totalBytes": {
              "format": "int64",
              "type": "integer"
            }
          },
          "type": "object",
          "additionalProperties": false
        },
        "startTimestamp": {
          "description": "StartTimestamp records the time a restore was started.\nThe server's time is used for StartTimestamps",
          "format": "date-time",
          "nullable": true,
          "type": "string"
        }
      },
      "type": "object",
      "additionalProperties": false
    }
  },
  "type": "object"
}