UpdateFolderInput
Input for updateFolder. A patch: every field except id is optional, and an omitted (null) field keeps its stored value rather than clearing it.
Fields
New folder name; must stay unique within the tenant. Omit (null) to leave the stored name unchanged — an update that doesn't rename need not resend it.
New description (max 1000 characters). Omit (null) to leave the stored description unchanged; null does NOT clear it.
New binding kind. Omit (null) to keep the current binding wholesale. Supplying the current kind without a new reference ID keeps the current reference. Rebinding is rejected if any file already references this folder.
Possible values (3)
CONTROL_CLOUDThe bytes live in ControlApp's own cloud file store, which the platform operates on the tenant's behalf. Control must configure a storage account; storageCapabilities and testFolder report read-only prerequisites. The store mints its own storage keys, so this is the one kind whose rootPath carries no meaning and is ignored.
STORAGE_BACKENDThe bytes live under a path inside one of the tenant's own StorageBackend rows, so the tenant supplies the account and credentials. storageBackendId names the backend and rootPath is a relative prefix within it, never starting with a slash.
CONTROLLERThe bytes live on the filesystem of an edge controller and are reached over file RPC rather than any cloud API, so the folder is only usable while that controller is online. controllerId names it and rootPath is an absolute path on that machine.
TypeID of the storage backend to bind to (e.g. "sbk_01K…"), used when the resulting kind is STORAGE_BACKEND. Omit (null) to keep the currently bound backend. Must name a backend in this tenant.
TypeID of the edge controller to bind to (e.g. "ctl_01K…"), used when the resulting kind is CONTROLLER. Omit (null) to keep the currently bound controller. Must name a controller in this tenant.
New root path/prefix, normalized and validated for the resulting binding as on create. Omit (null) to keep the stored root path. Changing it is rejected if any file already references this folder, since stored file handles would resolve against the wrong prefix.
Promote this folder to the tenant default. Omit (null) to keep the stored flag. Passing false on the current default is rejected — a tenant must always have exactly one default; promote another folder instead.
Referenced by (1)
Exact type SDL
"""
Input for updateFolder. A patch: every field except id is optional, and an omitted (null) field keeps its stored value rather than clearing it.
"""
input UpdateFolderInput {
"""
New folder name; must stay unique within the tenant. Omit (null) to leave the stored name unchanged — an update that doesn't rename need not resend it.
"""
name: String
"""
New description (max 1000 characters). Omit (null) to leave the stored description unchanged; null does NOT clear it.
"""
description: String
"""
New binding kind. Omit (null) to keep the current binding wholesale. Supplying the current kind without a new reference ID keeps the current reference. Rebinding is rejected if any file already references this folder.
"""
kind: FolderBindingKind
"""
TypeID of the storage backend to bind to (e.g. "sbk_01K…"), used when the resulting kind is STORAGE_BACKEND. Omit (null) to keep the currently bound backend. Must name a backend in this tenant.
"""
storageBackendId: StorageBackendID
"""
TypeID of the edge controller to bind to (e.g. "ctl_01K…"), used when the resulting kind is CONTROLLER. Omit (null) to keep the currently bound controller. Must name a controller in this tenant.
"""
controllerId: ControllerID
"""
New root path/prefix, normalized and validated for the resulting binding as on create. Omit (null) to keep the stored root path. Changing it is rejected if any file already references this folder, since stored file handles would resolve against the wrong prefix.
"""
rootPath: String
"""
Promote this folder to the tenant default. Omit (null) to keep the stored flag. Passing false on the current default is rejected — a tenant must always have exactly one default; promote another folder instead.
"""
isDefault: Boolean
}