Skip to main content

Class: DescribeActivityExecutionResponse

Represents a DescribeActivityExecutionResponse.

Properties​

callbacks​

callbacks: $Properties[]

Callbacks attached to this activity execution and their current state.

info?​

optional info?: $Properties | null

Information about the activity execution. Fields heartbeat_details and last_failure are omitted unless the request has include_heartbeat_details or include_last_failure set to true, respectively.

input?​

optional input?: $Properties | null

Serialized activity input, passed as arguments to the activity function. Only set if include_input was true in the request.

longPollToken​

longPollToken: Uint8Array

Token for follow-on long-poll requests. Absent only if the activity is complete.

outcome?​

optional outcome?: $Properties | null

Only set if the activity is completed and include_outcome was true in the request.

runId​

runId: string

The run ID of the activity, useful when run_id was not specified in the request.

Methods​

toJSON()​

toJSON(): object

Converts this DescribeActivityExecutionResponse to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): DescribeActivityExecutionResponse & $Shape

Creates a new DescribeActivityExecutionResponse instance using the specified properties.

Parameters​
properties?​

$Shape

Properties to set

Returns​

DescribeActivityExecutionResponse & $Shape

DescribeActivityExecutionResponse instance

Call Signature​

static create(properties?): DescribeActivityExecutionResponse

Creates a new DescribeActivityExecutionResponse instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

DescribeActivityExecutionResponse

DescribeActivityExecutionResponse instance

decode()​

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

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

DescribeActivityExecutionResponse & $Shape

DescribeActivityExecutionResponse

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): DescribeActivityExecutionResponse & $Shape

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

DescribeActivityExecutionResponse & $Shape

DescribeActivityExecutionResponse

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

Parameters​

message​

$Properties

DescribeActivityExecutionResponse message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

DescribeActivityExecutionResponse message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): DescribeActivityExecutionResponse

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

Parameters​

object​

Plain object

Returns​

DescribeActivityExecutionResponse

DescribeActivityExecutionResponse

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

DescribeActivityExecutionResponse

DescribeActivityExecutionResponse

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object