Skip to main content

Class: StartActivityExecutionResponse

Represents a StartActivityExecutionResponse.

Properties​

eagerActivityTask?​

optional eagerActivityTask?: $Properties | null

The first activity task when eager execution was requested and accepted. This is set only for the first attempt of a newly started activity.

optional link?: $Properties | null

Link to the started activity.

runId​

runId: string

The run ID of the activity that was started - or used (via ACTIVITY_ID_CONFLICT_POLICY_USE_EXISTING).

started​

started: boolean

If true, a new activity was started.

Methods​

toJSON()​

toJSON(): object

Converts this StartActivityExecutionResponse to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): StartActivityExecutionResponse & $Shape

Creates a new StartActivityExecutionResponse instance using the specified properties.

Parameters​
properties?​

$Shape

Properties to set

Returns​

StartActivityExecutionResponse & $Shape

StartActivityExecutionResponse instance

Call Signature​

static create(properties?): StartActivityExecutionResponse

Creates a new StartActivityExecutionResponse instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

StartActivityExecutionResponse

StartActivityExecutionResponse instance

decode()​

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

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

StartActivityExecutionResponse & $Shape

StartActivityExecutionResponse

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): StartActivityExecutionResponse & $Shape

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

StartActivityExecutionResponse & $Shape

StartActivityExecutionResponse

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

Parameters​

message​

$Properties

StartActivityExecutionResponse message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

StartActivityExecutionResponse message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): StartActivityExecutionResponse

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

Parameters​

object​

Plain object

Returns​

StartActivityExecutionResponse

StartActivityExecutionResponse

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

StartActivityExecutionResponse

StartActivityExecutionResponse

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object