Skip to main content

Class: DescribeWorkflowExecutionRequest

workflowservice.v1.DescribeWorkflowExecutionRequest

Represents a DescribeWorkflowExecutionRequest.

Implements#

Constructors#

constructor#

new DescribeWorkflowExecutionRequest(properties?)

Constructs a new DescribeWorkflowExecutionRequest.

Parameters#

NameType
properties?IDescribeWorkflowExecutionRequest

Properties#

execution#

Optional execution: null | IWorkflowExecution

DescribeWorkflowExecutionRequest execution.

Implementation of#

IDescribeWorkflowExecutionRequest.execution


namespace#

namespace: string

DescribeWorkflowExecutionRequest namespace.

Implementation of#

IDescribeWorkflowExecutionRequest.namespace

Methods#

toJSON#

toJSON(): Object

Converts this DescribeWorkflowExecutionRequest to JSON.

Returns#

Object

JSON object


decode#

Static decode(reader, length?): DescribeWorkflowExecutionRequest

Decodes a DescribeWorkflowExecutionRequest message from the specified reader or buffer.

throws {Error} If the payload is not a reader or valid buffer

throws {$protobuf.util.ProtocolError} If required fields are missing

Parameters#

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from
length?number-

Returns#

DescribeWorkflowExecutionRequest

DescribeWorkflowExecutionRequest


decodeDelimited#

Static decodeDelimited(reader): DescribeWorkflowExecutionRequest

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

throws {Error} If the payload is not a reader or valid buffer

throws {$protobuf.util.ProtocolError} If required fields are missing

Parameters#

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns#

DescribeWorkflowExecutionRequest

DescribeWorkflowExecutionRequest


encode#

Static encode(message, writer?): Writer

Encodes the specified DescribeWorkflowExecutionRequest message. Does not implicitly {@link temporal.api.workflowservice.v1.DescribeWorkflowExecutionRequest.verify|verify} messages.

Parameters#

NameTypeDescription
messageIDescribeWorkflowExecutionRequestDescribeWorkflowExecutionRequest message or plain object to encode
writer?Writer-

Returns#

Writer

Writer


encodeDelimited#

Static encodeDelimited(message, writer?): Writer

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

Parameters#

NameTypeDescription
messageIDescribeWorkflowExecutionRequestDescribeWorkflowExecutionRequest message or plain object to encode
writer?Writer-

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#

NameTypeDescription
objectObjectPlain 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#

NameTypeDescription
messageDescribeWorkflowExecutionRequestDescribeWorkflowExecutionRequest
options?IConversionOptions-

Returns#

Object

Plain object