SAF Documentation

Appearance

@saflib/jobs-http

Interface: EnqueueOnBehalfOfParams ​

Extends ​

Properties ​

authority ​

authority: { kind: "request"; request_id: string; user_id: string; } | { kind: "resource"; resource_id: string; resource_kind: string; user_id: string; } | { cron_job_name: string; kind: "cron"; user_id: string; }

Type declaration ​

{ kind: "request"; request_id: string; user_id: string; }

kind ​

kind: "request"

Example ​
ts
request
@enum {string}

request_id ​

request_id: string

Description ​

Originating request id (e.g. X-Request-ID).

Example ​
ts
r - abc123;

user_id ​

user_id: string

Description ​

User who made the originating request.

Example ​
ts
Us7k_pQ2;

{ kind: "resource"; resource_id: string; resource_kind: string; user_id: string; }

kind ​

kind: "resource"

Example ​
ts
resource
@enum {string}

resource_id ​

resource_id: string

Description ​

Short id of the resource row that authorized the chain.

Example ​
ts
Ch7k_mN2;

resource_kind ​

resource_kind: string

Description ​

Product-specific resource type for resource_id (e.g. channel_subscription, importer). Tells consumers which table or domain object to resolve.

Example ​
ts
channel_subscription;

user_id ​

user_id: string

Description ​

Owner of the resource whose authority is used.

Example ​
ts
Us7k_pQ2;

{ cron_job_name: string; kind: "cron"; user_id: string; }

cron_job_name ​

cron_job_name: string

Description ​

Name of the cron job that enqueued this chain.

Example ​
ts
recoverySweep;

kind ​

kind: "cron"

Example ​
ts
cron
@enum {string}

user_id ​

user_id: string

Description ​

Admin who enabled the cron job (enabled_by).

Example ​
ts
Us7k_pQ2;

concurrency_key? ​

optional concurrency_key: null | string

Inherited from ​

EnqueueParams.concurrency_key

dedupe_key? ​

optional dedupe_key: null | string

Inherited from ​

EnqueueParams.dedupe_key

delay_ms? ​

optional delay_ms: number

Inherited from ​

EnqueueParams.delay_ms

operation_id ​

operation_id: string

Inherited from ​

EnqueueParams.operation_id

priority? ​

optional priority: number

Inherited from ​

EnqueueParams.priority

request? ​

optional request: object

body? ​

optional body: unknown

Description ​

JSON request body for the target operation, when any.

path_params? ​

optional path_params: object

Index Signature ​

[key: string]: unknown

Description ​

Path template substitutions keyed by parameter name.

query? ​

optional query: object

Index Signature ​

[key: string]: unknown

Description ​

Query string parameters keyed by name.

Inherited from ​

EnqueueParams.request

run_at? ​

optional run_at: string

Inherited from ​

EnqueueParams.run_at

user_id ​

user_id: string