Skip to main content

Class: Request

A Nexus request.

Properties​

cancelOperation?​

optional cancelOperation?: $Properties | null

Request cancelOperation.

capabilities?​

optional capabilities?: $Properties | null

Request capabilities.

endpoint​

endpoint: string

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

header: object

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.

Index Signature​

[k: string]: string

scheduledTime?​

optional scheduledTime?: $Properties | null

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. --)

startOperation?​

optional startOperation?: $Properties | null

Request startOperation.

variant?​

optional variant?: "startOperation" | "cancelOperation"

Request variant.

Methods​

toJSON()​

toJSON(): object

Converts this Request to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): Request & $Shape

Creates a new Request instance using the specified properties.

Parameters​
properties?​

$Shape

Properties to set

Returns​

Request & $Shape

Request instance

Call Signature​

static create(properties?): Request

Creates a new Request instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

Request

Request instance

decode()​

static decode(reader, length?): Request & $Shape

Decodes a Request message from the specified reader or buffer.

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

length?​

number

Message length if known beforehand

Returns​

Request & $Shape

Request

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): Request & $Shape

Decodes a Request message from the specified reader or buffer, length delimited.

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

Request & $Shape

Request

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

encode()​

static encode(message, writer?): Writer

Encodes the specified Request message. Does not implicitly temporal.api.nexus.v1.Request.verify|verify messages.

Parameters​

message​

$Properties

Request message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

Encodes the specified Request message, length delimited. Does not implicitly temporal.api.nexus.v1.Request.verify|verify messages.

Parameters​

message​

$Properties

Request message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): Request

Creates a Request message from a plain object. Also converts values to their respective internal types.

Parameters​

object​

Plain object

Returns​

Request

Request

toObject()​

static toObject(message, options?): object

Creates a plain object from a Request message. Also converts values to other types if specified.

Parameters​

message​

Request

Request

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object