Rclone restore target Schema¶
Note
This is auto-generated documentation from a JSON schema that is under construction, this will improve over time.
Return to the root config schema
https://raw.githubusercontent.com/elastisys/compliantkubernetes-apps/main/config/schemas/config.yaml#/properties/objectStorage/properties/restore/properties/targets/items
Details of a bucket to restore.
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
|---|---|---|---|---|---|---|---|
| Can be instantiated | No | Unknown status | No | Forbidden | Forbidden | none | config/schemas/config.yaml* |
TYPE:
object (Rclone restore target)
PROPERTIES:
| Property | Type | Required | Nullable | Defined by |
|---|---|---|---|---|
| destinationName | string |
Required | cannot be null | Welkin Apps Config |
| destinationType | string |
Optional | cannot be null | Welkin Apps Config |
| destinationPath | string |
Optional | cannot be null | Welkin Apps Config |
| sourceName | string |
Optional | cannot be null | Welkin Apps Config |
| sourceType | string |
Optional | cannot be null | Welkin Apps Config |
| sourcePath | string |
Optional | cannot be null | Welkin Apps Config |
| nameSuffix | string |
Optional | cannot be null | Welkin Apps Config |
destinationName¶
destinationName
-
is required
-
Type:
string(Destination bucket to sync) -
cannot be null
-
defined in: Welkin Apps Config
TYPE:
string (Destination bucket to sync)
destinationType¶
destinationType
-
is optional
-
Type:
string(Type of destination) -
cannot be null
-
defined in: Welkin Apps Config
TYPE:
string (Type of destination)
EXAMPLES:
s3
swift
azure
destinationPath¶
Rclone will sync files to this patch. Defaults to "" (root of bucket).
destinationPath
-
is optional
-
Type:
string(Path to restore to) -
cannot be null
-
defined in: Welkin Apps Config
TYPE:
string (Path to restore to)
sourceName¶
sourceName
-
is optional
-
Type:
string(Source bucket to sync) -
cannot be null
-
defined in: Welkin Apps Config
TYPE:
string (Source bucket to sync)
sourceType¶
sourceType
-
is optional
-
Type:
string(Type of source) -
cannot be null
-
defined in: Welkin Apps Config
TYPE:
string (Type of source)
EXAMPLES:
s3
swift
azure
sourcePath¶
Rclone will sync all files from this path. Defaults to "" (root of bucket).
sourcePath
-
is optional
-
Type:
string(Path to sync from) -
cannot be null
-
defined in: Welkin Apps Config
TYPE:
string (Path to sync from)
nameSuffix¶
Suffix added to the end of cronjob name. Defaults to "custom".
nameSuffix
-
is optional
-
Type:
string(Suffix to cronjob name) -
cannot be null
-
defined in: Welkin Apps Config
TYPE:
string (Suffix to cronjob name)
Return to the root config schema
Generated Sun Jan 19 03:48:14 UTC 2025 from elastisys/compliantkubernetes-apps@main