Skip to main content

Class: DescribeWorkflowExecutionRequest

workflowservice.v1.DescribeWorkflowExecutionRequest

Represents a DescribeWorkflowExecutionRequest.

Implements

Constructors

constructor

new DescribeWorkflowExecutionRequest(properties?)

Constructs a new DescribeWorkflowExecutionRequest.

Parameters

NameTypeDescription
properties?IDescribeWorkflowExecutionRequestProperties to set

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


create

Static create(properties?): DescribeWorkflowExecutionRequest

Creates a new DescribeWorkflowExecutionRequest instance using the specified properties.

Parameters

NameTypeDescription
properties?IDescribeWorkflowExecutionRequestProperties to set

Returns

DescribeWorkflowExecutionRequest

DescribeWorkflowExecutionRequest instance


decode

Static decode(reader, length?): DescribeWorkflowExecutionRequest

Decodes a DescribeWorkflowExecutionRequest message from the specified reader or buffer.

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

Parameters

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from
length?numberMessage length if known beforehand

Returns

DescribeWorkflowExecutionRequest

DescribeWorkflowExecutionRequest


decodeDelimited

Static decodeDelimited(reader): DescribeWorkflowExecutionRequest

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

Throws

If the payload is not a reader or valid buffer

Throws

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

Parameters

NameTypeDescription
messageIDescribeWorkflowExecutionRequestDescribeWorkflowExecutionRequest message or plain object to encode
writer?WriterWriter 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

NameTypeDescription
messageIDescribeWorkflowExecutionRequestDescribeWorkflowExecutionRequest message or plain object to encode
writer?WriterWriter 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

NameTypeDescription
objectObjectPlain object

Returns

DescribeWorkflowExecutionRequest

DescribeWorkflowExecutionRequest


getTypeUrl

Static getTypeUrl(typeUrlPrefix?): string

Gets the default type url for DescribeWorkflowExecutionRequest

Parameters

NameTypeDescription
typeUrlPrefix?stringyour custom typeUrlPrefix(default "type.googleapis.com")

Returns

string

The default type url


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?IConversionOptionsConversion options

Returns

Object

Plain object