Skip to main content

Class: DescribeWorkflowExecutionRequest

Represents a DescribeWorkflowExecutionRequest.

Properties​

execution?​

optional execution?: $Properties | null

DescribeWorkflowExecutionRequest execution.

namespace​

namespace: string

DescribeWorkflowExecutionRequest namespace.

Methods​

toJSON()​

toJSON(): object

Converts this DescribeWorkflowExecutionRequest to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): DescribeWorkflowExecutionRequest & $Properties

Creates a new DescribeWorkflowExecutionRequest instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

DescribeWorkflowExecutionRequest & $Properties

DescribeWorkflowExecutionRequest instance

Call Signature​

static create(properties?): DescribeWorkflowExecutionRequest

Creates a new DescribeWorkflowExecutionRequest instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

DescribeWorkflowExecutionRequest

DescribeWorkflowExecutionRequest instance

decode()​

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

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

DescribeWorkflowExecutionRequest & $Properties

DescribeWorkflowExecutionRequest

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): DescribeWorkflowExecutionRequest & $Properties

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

DescribeWorkflowExecutionRequest & $Properties

DescribeWorkflowExecutionRequest

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

Parameters​

message​

$Properties

DescribeWorkflowExecutionRequest message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

DescribeWorkflowExecutionRequest message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): DescribeWorkflowExecutionRequest

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

Parameters​

object​

Plain object

Returns​

DescribeWorkflowExecutionRequest

DescribeWorkflowExecutionRequest

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

DescribeWorkflowExecutionRequest

DescribeWorkflowExecutionRequest

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object