Skip to main content

Class: WorkflowRuleAction

Represents a WorkflowRuleAction.

Properties​

activityPause?​

optional activityPause?: $Properties | null

WorkflowRuleAction activityPause.

variant?​

optional variant?: "activityPause"

Supported actions.

Methods​

toJSON()​

toJSON(): object

Converts this WorkflowRuleAction to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): WorkflowRuleAction & $Shape

Creates a new WorkflowRuleAction instance using the specified properties.

Parameters​
properties?​

$Shape

Properties to set

Returns​

WorkflowRuleAction & $Shape

WorkflowRuleAction instance

Call Signature​

static create(properties?): WorkflowRuleAction

Creates a new WorkflowRuleAction instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

WorkflowRuleAction

WorkflowRuleAction instance

decode()​

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

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

WorkflowRuleAction & $Shape

WorkflowRuleAction

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): WorkflowRuleAction & $Shape

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

WorkflowRuleAction & $Shape

WorkflowRuleAction

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

Parameters​

message​

$Properties

WorkflowRuleAction message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

WorkflowRuleAction message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): WorkflowRuleAction

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

Parameters​

object​

Plain object

Returns​

WorkflowRuleAction

WorkflowRuleAction

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

WorkflowRuleAction

WorkflowRuleAction

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object