Admin, Ops & Multi-Tenancy

Operators run backups, restores, and compaction via BackupClient; manage pipelines, feeds, notification rules, jobs, and LLM config via SystemClient; manage tenants, tiers, sharing, and platform usage via TenantAdminClient; and mint/revoke bearer tokens via TokenClient.

46 methods across this domain. Signatures, parameters (incl. keyword-only tunable defaults), and the three SDK spellings are ported from the live SDK source; flagship methods carry a hand-written When to use + example.

`BackupClient`

`restore(snapshot_id, tenant=None, point_in_time_ns=None)`

When to use. Restore from a snapshot; poll with wait_for_restore / restore_status.

Python — client.backupclient.restore(snapshot_id, tenant=None, point_in_time_ns=None)
TypeScript — restore(snapshotId, opts)
Go — Restore(snapshotID)

Parameters: snapshot_id, tenant=None, point_in_time_ns=None

Example

rid = BackupClient.from_client(relata).restore(snapshot_id="snap-9")

`compact()`

compact()`

Python — client.backupclient.compact()
TypeScript — compact()
Go — Compact()

`create(kind='full', tenant=None)`

create(kind='full', tenant=None)`

Python — client.backupclient.create(kind='full', tenant=None)
TypeScript — create(opts)
Go — Create()

Parameters: kind='full', tenant=None

`list()`

list()`

Python — client.backupclient.list()
TypeScript — list()
Go — List()

`restore_status(restore_id)`

restore_status(restore_id)`

Python — client.backupclient.restore_status(restore_id)
TypeScript — restoreStatus(restoreId)
Go — RestoreStatus(restoreID)

Parameters: restore_id

`wait_for_restore(restore_id, timeout_secs=300.0, poll_interval_secs=2.0)`

wait_for_restore(restore_id, timeout_secs=300.0, poll_interval_secs=2.0)`

Python — client.backupclient.wait_for_restore(restore_id, timeout_secs=300.0, poll_interval_secs=2.0)
TypeScript — waitForRestore(restoreId, opts)
Go — WaitForRestore(restoreID)

Parameters: restore_id, timeout_secs=300.0, poll_interval_secs=2.0

`RelataClient`

`cluster_drain(node_id)`

cluster_drain(node_id)`

Python — client.relataclient.cluster_drain(node_id)
TypeScript — clusterDrain(nodeId)
Go — ClusterDrain(nodeID)

Parameters: node_id

`cluster_nodes()`

cluster_nodes()`

Python — client.relataclient.cluster_nodes()
TypeScript — clusterNodes()
Go — ClusterNodes()

`cluster_rebalance()`

cluster_rebalance()`

Python — client.relataclient.cluster_rebalance()
TypeScript — clusterRebalance()
Go — ClusterRebalance()

`cluster_topology()`

cluster_topology()`

Python — client.relataclient.cluster_topology()
TypeScript — clusterTopology()
Go — ClusterTopology()

`SystemClient`

`create_notification_rule(rule)`

create_notification_rule(rule)`

Python — client.systemclient.create_notification_rule(rule)
TypeScript — createNotificationRule(rule)
Go — CreateNotificationRule(rule)

Parameters: rule

`define_pipeline(definition)`

define_pipeline(definition)`

Python — client.systemclient.define_pipeline(definition)
TypeScript — definePipeline(definition)
Go — DefinePipeline(definition)

Parameters: definition

`delete_notification_rule(rule_id)`

delete_notification_rule(rule_id)`

Python — client.systemclient.delete_notification_rule(rule_id)
TypeScript — deleteNotificationRule(id)
Go — DeleteNotificationRule(id)

Parameters: rule_id

`feed_channels()`

feed_channels()`

Python — client.systemclient.feed_channels()
TypeScript — feedChannels()
Go — FeedChannels()

`feed_health()`

feed_health()`

Python — client.systemclient.feed_health()
TypeScript — feedHealth()
Go — FeedHealth()

`feed_publish(channel, payload)`

feed_publish(channel, payload)`

Python — client.systemclient.feed_publish(channel, payload)
TypeScript — feedPublish(channel, payload)
Go — FeedPublish(channel, payload)

Parameters: channel, payload

`get_workflow(name)`

get_workflow(name)`

Python — client.systemclient.get_workflow(name)
TypeScript — getWorkflow(name)
Go — GetWorkflow(name)

Parameters: name

`job_status(name)`

job_status(name)`

Python — client.systemclient.job_status(name)
TypeScript — jobStatus(name)
Go — JobStatus(name)

Parameters: name

`jobs_status()`

jobs_status()`

Python — client.systemclient.jobs_status()
TypeScript — jobsStatus()
Go — JobsStatus()

`list_pipelines()`

list_pipelines()`

Python — client.systemclient.list_pipelines()
TypeScript — listPipelines()
Go — ListPipelines()

`list_workflows()`

list_workflows()`

Python — client.systemclient.list_workflows()
TypeScript — listWorkflows()
Go — ListWorkflows()

`llm_config()`

llm_config()`

Python — client.systemclient.llm_config()
TypeScript — llmConfig()
Go — LLMConfig()

`notification_rules()`

notification_rules()`

Python — client.systemclient.notification_rules()
TypeScript — notificationRules()
Go — NotificationRules()

`register_workflow(name, steps)`

register_workflow(name, steps)`

Python — client.systemclient.register_workflow(name, steps)
TypeScript — registerWorkflow(name, steps)
Go — RegisterWorkflow(name, steps)

Parameters: name, steps

`run_workflow(name)`

run_workflow(name)`

Python — client.systemclient.run_workflow(name)
TypeScript — runWorkflow(name)
Go — RunWorkflow(name)

Parameters: name

`test_llm(prompt, model=None)`

test_llm(prompt, model=None)`

Python — client.systemclient.test_llm(prompt, model=None)
TypeScript — testLlm(prompt, opts)
Go — TestLLM(prompt)

Parameters: prompt, model=None

`workflow_run(run_id)`

workflow_run(run_id)`

Python — client.systemclient.workflow_run(run_id)
TypeScript — workflowRun(runId)
Go — WorkflowRun(runID)

Parameters: run_id

`workflow_status(name)`

workflow_status(name)`

Python — client.systemclient.workflow_status(name)
TypeScript — workflowStatus(name)
Go — WorkflowStatus(name)

Parameters: name

`TenantAdminClient`

`create_sharing(tenant_id, partner_tenant, object_type, action='read', expires_ns=None)`

When to use. Establish a governed cross-tenant data-sharing agreement.

Python — client.tenantadminclient.create_sharing(tenant_id, partner_tenant, object_type, action='read', expires_ns=None)
TypeScript — createSharing(tenantId, partnerTenant, opts)
Go — CreateSharing(tenantID, partnerTenant, objectType)

Parameters: tenant_id, partner_tenant, object_type, action='read', expires_ns=None

Example

TenantAdminClient.from_client(relata).create_sharing("acme", partner_tenant="beta")

`set_tier(tenant_id, tier)`

When to use. Move a tenant between tiers (operator surface, cluster-only multi-tenant).

Python — client.tenantadminclient.set_tier(tenant_id, tier)
TypeScript — setTier(tenantId, tier)
Go — SetTier(tenantID, tier)

Parameters: tenant_id, tier

Example

TenantAdminClient.from_client(relata).set_tier("acme", tier="enterprise")

`create(tenant_id, tier='standard', **fields)`

create(tenant_id, tier='standard', **fields)`

Python — client.tenantadminclient.create(tenant_id, tier='standard', **fields)
TypeScript — create(tenantId, opts)
Go — Create(tenantID)

Parameters: tenant_id, tier='standard', **fields

`delete(tenant_id)`

delete(tenant_id)`

Python — client.tenantadminclient.delete(tenant_id)
Go — Delete(tenantID)

Parameters: tenant_id

`get(tenant_id)`

get(tenant_id)`

Python — client.tenantadminclient.get(tenant_id)
TypeScript — get(tenantId)
Go — Get(tenantID)

Parameters: tenant_id

`list_sharing(tenant_id)`

list_sharing(tenant_id)`

Python — client.tenantadminclient.list_sharing(tenant_id)
TypeScript — listSharing(tenantId)
Go — ListSharing(tenantID)

Parameters: tenant_id

`me()`

me()`

Python — client.tenantadminclient.me()
TypeScript — me()
Go — Me()

`platform_license()`

platform_license()`

Python — client.tenantadminclient.platform_license()
TypeScript — platformLicense()
Go — PlatformLicense()

`platform_usage()`

platform_usage()`

Python — client.tenantadminclient.platform_usage()
TypeScript — platformUsage()
Go — PlatformUsage()

`reactivate(tenant_id)`

reactivate(tenant_id)`

Python — client.tenantadminclient.reactivate(tenant_id)
TypeScript — reactivate(tenantId)
Go — Reactivate(tenantID)

Parameters: tenant_id

`set_quota(tenant_id, quota)`

set_quota(tenant_id, quota)`

Python — client.tenantadminclient.set_quota(tenant_id, quota)
TypeScript — setQuota(tenantId, quota)
Go — SetQuota(tenantID, quota)

Parameters: tenant_id, quota

`suspend(tenant_id)`

suspend(tenant_id)`

Python — client.tenantadminclient.suspend(tenant_id)
TypeScript — suspend(tenantId)
Go — Suspend(tenantID)

Parameters: tenant_id

`tenant_usage(tenant_id)`

tenant_usage(tenant_id)`

Python — client.tenantadminclient.tenant_usage(tenant_id)
TypeScript — tenantUsage(tenantId)
Go — TenantUsage(tenantID)

Parameters: tenant_id

`usage()`

usage()`

Python — client.tenantadminclient.usage()
TypeScript — usage()
Go — Usage()

`TokenClient`

`check(token_id)`

check(token_id)`

Python — client.tokenclient.check(token_id)
TypeScript — check(tokenId)
Go — Check(tokenID)

Parameters: token_id

`remember(token_id, ttl_secs=None)`

remember(token_id, ttl_secs=None)`

Python — client.tokenclient.remember(token_id, ttl_secs=None)
TypeScript — remember(tokenId, opts)
Go — Remember(tokenID)

Parameters: token_id, ttl_secs=None

`revoke(token_id)`

revoke(token_id)`

Python — client.tokenclient.revoke(token_id)
TypeScript — revoke(tokenId)
Go — Revoke(tokenID)

Parameters: token_id

`stats()`

stats()`

Python — client.tokenclient.stats()
TypeScript — stats()
Go — Stats()

Admin, Ops & Multi-Tenancy#

BackupClient#

restore(snapshot_id, tenant=None, point_in_time_ns=None)#

compact()#

create(kind='full', tenant=None)#

list()#

restore_status(restore_id)#

wait_for_restore(restore_id, timeout_secs=300.0, poll_interval_secs=2.0)#

RelataClient#

cluster_drain(node_id)#

cluster_nodes()#

cluster_rebalance()#

cluster_topology()#

SystemClient#

create_notification_rule(rule)#

define_pipeline(definition)#

delete_notification_rule(rule_id)#

feed_channels()#

feed_health()#

feed_publish(channel, payload)#

get_workflow(name)#

job_status(name)#

jobs_status()#

list_pipelines()#

list_workflows()#

llm_config()#

notification_rules()#

register_workflow(name, steps)#

run_workflow(name)#

test_llm(prompt, model=None)#

workflow_run(run_id)#

workflow_status(name)#

TenantAdminClient#

create_sharing(tenant_id, partner_tenant, object_type, action='read', expires_ns=None)#

set_tier(tenant_id, tier)#

create(tenant_id, tier='standard', **fields)#

delete(tenant_id)#

get(tenant_id)#

list_sharing(tenant_id)#

me()#

platform_license()#

platform_usage()#

reactivate(tenant_id)#

set_quota(tenant_id, quota)#

suspend(tenant_id)#

tenant_usage(tenant_id)#

usage()#

TokenClient#

check(token_id)#

remember(token_id, ttl_secs=None)#

revoke(token_id)#

stats()#

Admin, Ops & Multi-Tenancy

`BackupClient`

`restore(snapshot_id, tenant=None, point_in_time_ns=None)`

`compact()`

`create(kind='full', tenant=None)`

`list()`

`restore_status(restore_id)`

`wait_for_restore(restore_id, timeout_secs=300.0, poll_interval_secs=2.0)`

`RelataClient`

`cluster_drain(node_id)`

`cluster_nodes()`

`cluster_rebalance()`

`cluster_topology()`

`SystemClient`

`create_notification_rule(rule)`

`define_pipeline(definition)`

`delete_notification_rule(rule_id)`

`feed_channels()`

`feed_health()`

`feed_publish(channel, payload)`

`get_workflow(name)`

`job_status(name)`

`jobs_status()`

`list_pipelines()`

`list_workflows()`

`llm_config()`

`notification_rules()`

`register_workflow(name, steps)`

`run_workflow(name)`

`test_llm(prompt, model=None)`

`workflow_run(run_id)`

`workflow_status(name)`

`TenantAdminClient`

`create_sharing(tenant_id, partner_tenant, object_type, action='read', expires_ns=None)`

`set_tier(tenant_id, tier)`

`create(tenant_id, tier='standard', **fields)`

`delete(tenant_id)`

`get(tenant_id)`

`list_sharing(tenant_id)`

`me()`

`platform_license()`

`platform_usage()`

`reactivate(tenant_id)`

`set_quota(tenant_id, quota)`

`suspend(tenant_id)`

`tenant_usage(tenant_id)`

`usage()`

`TokenClient`

`check(token_id)`

`remember(token_id, ttl_secs=None)`

`revoke(token_id)`

`stats()`