Skip to main content

Class: StartOperationResponse

Response variant for StartOperationRequest.

Properties​

asyncSuccess?​

optional asyncSuccess?: $Properties | null

StartOperationResponse asyncSuccess.

failure?​

optional failure?: $Properties | null

The operation completed unsuccessfully (failed or canceled). Failure object must contain an ApplicationFailureInfo or CanceledFailureInfo object.

operationError?​

optional operationError?: $Properties | null

The operation completed unsuccessfully (failed or canceled). Deprecated. Use the failure variant instead.

syncSuccess?​

optional syncSuccess?: $Properties | null

StartOperationResponse syncSuccess.

variant?​

optional variant?: "failure" | "syncSuccess" | "asyncSuccess" | "operationError"

StartOperationResponse variant.

Methods​

toJSON()​

toJSON(): object

Converts this StartOperationResponse to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): StartOperationResponse & $Shape

Creates a new StartOperationResponse instance using the specified properties.

Parameters​
properties?​

$Shape

Properties to set

Returns​

StartOperationResponse & $Shape

StartOperationResponse instance

Call Signature​

static create(properties?): StartOperationResponse

Creates a new StartOperationResponse instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

StartOperationResponse

StartOperationResponse instance

decode()​

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

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

StartOperationResponse & $Shape

StartOperationResponse

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): StartOperationResponse & $Shape

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

StartOperationResponse & $Shape

StartOperationResponse

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

Parameters​

message​

$Properties

StartOperationResponse message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

StartOperationResponse message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): StartOperationResponse

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

Parameters​

object​

Plain object

Returns​

StartOperationResponse

StartOperationResponse

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

StartOperationResponse

StartOperationResponse

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object