ExportSettings

ExportSettings
ExportSettings

The specification of export configuration.

JSON Example
{
    "schedule": {
        "time": {
            "hh": 0,
            "mm": 0
        },
        "frequency": 0,
        "day_of_week": "string"
    },
    "enable_scheduler": false,
    "retention": 0,
    "datastore_path": {
        "datastore": "Datastore:datastore-16:ff4a23e7-2fed-4be0-be39-479ae372badd",
        "path": "/path/to/folder",
        "datastore_name": "local-datastore"
    }
}
ScheduleSpec
schedule
Optional

Describe the schedule of export operation.

boolean
enable_scheduler
Optional

Activate or deactivate export config on schedule. If this value is not set, the previously set value is used. If this is never configured, the default value is 'false'.

integer As int32 As int32
retention
Optional
Constraints: minimum: 1

How many export files should remain. If this value is not set, the previously set value is used. If this is never configured, the default value is '32'.

DatastoreDirectory
datastore_path
Optional

The location of a directory on a datastore.

Used By