Skip to main content

Class: DescribeWorkflowRuleRequest

Represents a DescribeWorkflowRuleRequest.

Properties​

namespace​

namespace: string

DescribeWorkflowRuleRequest namespace.

ruleId​

ruleId: string

User-specified ID of the rule to read. Unique within the namespace.

Methods​

toJSON()​

toJSON(): object

Converts this DescribeWorkflowRuleRequest to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): DescribeWorkflowRuleRequest & $Properties

Creates a new DescribeWorkflowRuleRequest instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

DescribeWorkflowRuleRequest & $Properties

DescribeWorkflowRuleRequest instance

Call Signature​

static create(properties?): DescribeWorkflowRuleRequest

Creates a new DescribeWorkflowRuleRequest instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

DescribeWorkflowRuleRequest

DescribeWorkflowRuleRequest instance

decode()​

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

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

DescribeWorkflowRuleRequest & $Properties

DescribeWorkflowRuleRequest

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): DescribeWorkflowRuleRequest & $Properties

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

DescribeWorkflowRuleRequest & $Properties

DescribeWorkflowRuleRequest

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

Parameters​

message​

$Properties

DescribeWorkflowRuleRequest message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

DescribeWorkflowRuleRequest message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): DescribeWorkflowRuleRequest

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

Parameters​

object​

Plain object

Returns​

DescribeWorkflowRuleRequest

DescribeWorkflowRuleRequest

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

DescribeWorkflowRuleRequest

DescribeWorkflowRuleRequest

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object