Skip to main content

Class: Request

nexus.v1.Request

A Nexus request.

Implements

Constructors

constructor

new Request(properties?): Request

Constructs a new Request.

Parameters

NameTypeDescription
properties?IRequestProperties to set

Returns

Request

Properties

cancelOperation

Optional cancelOperation: null | ICancelOperationRequest

Request cancelOperation.

Implementation of

IRequest.cancelOperation


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

Implementation of

IRequest.header


scheduledTime

Optional scheduledTime: null | ITimestamp

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

Implementation of

IRequest.scheduledTime


startOperation

Optional startOperation: null | IStartOperationRequest

Request startOperation.

Implementation of

IRequest.startOperation


variant

Optional variant: "startOperation" | "cancelOperation"

Request variant.

Methods

toJSON

toJSON(): Object

Converts this Request to JSON.

Returns

Object

JSON object


create

create(properties?): Request

Creates a new Request instance using the specified properties.

Parameters

NameTypeDescription
properties?IRequestProperties to set

Returns

Request

Request instance


decode

decode(reader, length?): Request

Decodes a Request message from the specified reader or buffer.

Parameters

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from
length?numberMessage length if known beforehand

Returns

Request

Request

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing


decodeDelimited

decodeDelimited(reader): Request

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

Parameters

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns

Request

Request

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing


encode

encode(message, writer?): Writer

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

Parameters

NameTypeDescription
messageIRequestRequest message or plain object to encode
writer?WriterWriter to encode to

Returns

Writer

Writer


encodeDelimited

encodeDelimited(message, writer?): Writer

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

Parameters

NameTypeDescription
messageIRequestRequest message or plain object to encode
writer?WriterWriter to encode to

Returns

Writer

Writer


fromObject

fromObject(object): Request

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

Parameters

NameTypeDescription
objectObjectPlain object

Returns

Request

Request


getTypeUrl

getTypeUrl(typeUrlPrefix?): string

Gets the default type url for Request

Parameters

NameTypeDescription
typeUrlPrefix?stringyour custom typeUrlPrefix(default "type.googleapis.com")

Returns

string

The default type url


toObject

toObject(message, options?): Object

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

Parameters

NameTypeDescription
messageRequestRequest
options?IConversionOptionsConversion options

Returns

Object

Plain object