Skip to main content

Class: DescribeWorkflowExecutionResponse

Represents a DescribeWorkflowExecutionResponse.

Properties​

callbacks​

callbacks: $Properties[]

DescribeWorkflowExecutionResponse callbacks.

executionConfig?​

optional executionConfig?: $Properties | null

DescribeWorkflowExecutionResponse executionConfig.

pendingActivities​

pendingActivities: $Properties[]

DescribeWorkflowExecutionResponse pendingActivities.

pendingChildren​

pendingChildren: $Properties[]

DescribeWorkflowExecutionResponse pendingChildren.

pendingNexusOperations​

pendingNexusOperations: $Properties[]

DescribeWorkflowExecutionResponse pendingNexusOperations.

pendingWorkflowTask?​

optional pendingWorkflowTask?: $Properties | null

DescribeWorkflowExecutionResponse pendingWorkflowTask.

workflowExecutionInfo?​

optional workflowExecutionInfo?: $Properties | null

DescribeWorkflowExecutionResponse workflowExecutionInfo.

workflowExtendedInfo?​

optional workflowExtendedInfo?: $Properties | null

DescribeWorkflowExecutionResponse workflowExtendedInfo.

Methods​

toJSON()​

toJSON(): object

Converts this DescribeWorkflowExecutionResponse to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): DescribeWorkflowExecutionResponse & $Shape

Creates a new DescribeWorkflowExecutionResponse instance using the specified properties.

Parameters​
properties?​

$Shape

Properties to set

Returns​

DescribeWorkflowExecutionResponse & $Shape

DescribeWorkflowExecutionResponse instance

Call Signature​

static create(properties?): DescribeWorkflowExecutionResponse

Creates a new DescribeWorkflowExecutionResponse instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

DescribeWorkflowExecutionResponse

DescribeWorkflowExecutionResponse instance

decode()​

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

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

DescribeWorkflowExecutionResponse & $Shape

DescribeWorkflowExecutionResponse

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): DescribeWorkflowExecutionResponse & $Shape

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

DescribeWorkflowExecutionResponse & $Shape

DescribeWorkflowExecutionResponse

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

Parameters​

message​

$Properties

DescribeWorkflowExecutionResponse message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

DescribeWorkflowExecutionResponse message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): DescribeWorkflowExecutionResponse

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

Parameters​

object​

Plain object

Returns​

DescribeWorkflowExecutionResponse

DescribeWorkflowExecutionResponse

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

DescribeWorkflowExecutionResponse

DescribeWorkflowExecutionResponse

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object