Skip to main content

Interface: IRequest

nexus.v1.IRequest

Properties of a Request.

Hierarchy

Properties

cancelOperation

Optional cancelOperation: null | $Properties

Request cancelOperation

Inherited from

$Properties.cancelOperation


capabilities

Optional capabilities: null | $Properties

Request capabilities

Inherited from

$Properties.capabilities


endpoint

Optional endpoint: null | string

The endpoint this request was addressed to before forwarding to the worker. Supported from server version 1.30.0.

Inherited from

$Properties.endpoint


Optional header: null | { [k: string]: string; }

Headers extracted from the original request in the Temporal frontend. When using Nexus over HTTP, this includes the request's HTTP headers ignoring multiple values.

Inherited from

$Properties.header


scheduledTime

Optional scheduledTime: null | $Properties

The timestamp when the request was scheduled in the frontend. (-- api-linter: core::0142::time-field-names=disabled aip.dev/not-precedent: Not following linter rules. --)

Inherited from

$Properties.scheduledTime


startOperation

Optional startOperation: null | $Properties

Request startOperation

Inherited from

$Properties.startOperation


variant

Optional variant: "startOperation" | "cancelOperation"

Request variant

Inherited from

$Properties.variant