Skip to main content

Class: StartOperationRequest

A request to start an operation.

Properties​

callback​

callback: string

Callback URL to call upon completion if the started operation is async.

callbackHeader​

callbackHeader: object

Header that is expected to be attached to the callback request when the operation completes.

Index Signature​

[k: string]: string

links: $Properties[]

Links contain caller information and can be attached to the operations started by the handler.

operation​

operation: string

Type of operation to start.

payload?​

optional payload?: $Properties | null

Full request body from the incoming HTTP request.

requestId​

requestId: string

A request ID that can be used as an idempotentency key.

service​

service: string

Name of service to start the operation in.

Methods​

toJSON()​

toJSON(): object

Converts this StartOperationRequest to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): StartOperationRequest & $Properties

Creates a new StartOperationRequest instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

StartOperationRequest & $Properties

StartOperationRequest instance

Call Signature​

static create(properties?): StartOperationRequest

Creates a new StartOperationRequest instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

StartOperationRequest

StartOperationRequest instance

decode()​

static decode(reader, length?): StartOperationRequest & $Properties

Decodes a StartOperationRequest 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​

StartOperationRequest & $Properties

StartOperationRequest

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): StartOperationRequest & $Properties

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

StartOperationRequest & $Properties

StartOperationRequest

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 StartOperationRequest message. Does not implicitly temporal.api.nexus.v1.StartOperationRequest.verify|verify messages.

Parameters​

message​

$Properties

StartOperationRequest message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

StartOperationRequest message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): StartOperationRequest

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

Parameters​

object​

Plain object

Returns​

StartOperationRequest

StartOperationRequest

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

StartOperationRequest

StartOperationRequest

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object