UpdateArchiveJobInput
Input for updating an archive job. Only provided fields are changed.
Fields
New display name. Omit to leave unchanged.
New free-text note (max 1000 characters). Omit to leave unchanged.
New URL-safe identifier matching [a-z0-9][a-z0-9-]*; must stay unique within the tenant. Changing it changes the rendered storage keys of future runs. Omit to leave unchanged.
TypeID (prefix sbk) of a different storage backend to write to; must exist for the tenant. Omit to leave unchanged.
New 5-field cron expression; rejected if it does not parse. Omit to leave unchanged.
New IANA timezone for evaluating the cron expression. Omit to leave unchanged.
New behaviour when a tick fires during a still-running run. Omit to leave unchanged.
Possible values (3)
ALLOWAllow overlapping CRON executions
SKIPSkip if previous execution still running
CANCELCancel previous and start new
New Lua source; must be non-empty. Omit to leave unchanged.
New storage key template; supports {slug}, {yyyy}, {mm}, {dd}, {yyyy-MM-dd}, {timestamp}, {executionId}. Omit to leave unchanged.
New output encoding. Switching to CSV requires the script's schema to be scalars only. Omit to leave unchanged.
Possible values (2)
PARQUETApache Parquet — typed, columnar, DuckDB-friendly. Default.
CSVRFC 4180 CSV with UTF-8 BOM. For Excel / Power BI. Schema must be scalars only.
Enable or disable the cron schedule. Omit to leave unchanged.
Referenced by (1)
Exact type SDL
"""Input for updating an archive job. Only provided fields are changed."""
input UpdateArchiveJobInput {
"""New display name. Omit to leave unchanged."""
name: String
"""New free-text note (max 1000 characters). Omit to leave unchanged."""
description: String
"""
New URL-safe identifier matching `[a-z0-9][a-z0-9-]*`; must stay unique within the tenant. Changing it changes the rendered storage keys of future runs. Omit to leave unchanged.
"""
slug: String
"""
TypeID (prefix `sbk`) of a different storage backend to write to; must exist for the tenant. Omit to leave unchanged.
"""
storageBackendId: StorageBackendID
"""
New 5-field cron expression; rejected if it does not parse. Omit to leave unchanged.
"""
cronExpression: String
"""
New IANA timezone for evaluating the cron expression. Omit to leave unchanged.
"""
timezone: String
"""
New behaviour when a tick fires during a still-running run. Omit to leave unchanged.
"""
overlapPolicy: OverlapPolicy
"""New Lua source; must be non-empty. Omit to leave unchanged."""
script: String
"""
New storage key template; supports `{slug}`, `{yyyy}`, `{mm}`, `{dd}`, `{yyyy-MM-dd}`, `{timestamp}`, `{executionId}`. Omit to leave unchanged.
"""
keyTemplate: String
"""
New output encoding. Switching to CSV requires the script's schema to be scalars only. Omit to leave unchanged.
"""
outputFormat: ArchiveOutputFormat
"""Enable or disable the cron schedule. Omit to leave unchanged."""
isEnabled: Boolean
}