Class: TriggerWorkflowRuleRequest

Represents a TriggerWorkflowRuleRequest.

Properties

execution?

optional execution?: $Properties | null

Execution info of the workflow which scheduled this activity

---

id?

optional id?: string | null

TriggerWorkflowRuleRequest id.

---

identity

identity: string

The identity of the client who initiated this request

---

namespace

namespace: string

TriggerWorkflowRuleRequest namespace.

---

rule?

optional rule?: "id" | "spec"

Either provide id of existing rule, or rule specification

---

spec?

optional spec?: $Properties | null

Note: Rule ID and expiration date are not used in the trigger request.

Methods

toJSON()

toJSON(): object

Converts this TriggerWorkflowRuleRequest to JSON.

Returns

object

JSON object

---

create()

Call Signature

static create(properties?): TriggerWorkflowRuleRequest & $Shape

Creates a new TriggerWorkflowRuleRequest instance using the specified properties.

Parameters

properties?

$Shape

Properties to set

Returns

TriggerWorkflowRuleRequest & $Shape

TriggerWorkflowRuleRequest instance

Call Signature

static create(properties?): TriggerWorkflowRuleRequest

Creates a new TriggerWorkflowRuleRequest instance using the specified properties.

Parameters

properties?

$Properties

Properties to set

Returns

TriggerWorkflowRuleRequest

TriggerWorkflowRuleRequest instance

---

decode()

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

Decodes a TriggerWorkflowRuleRequest 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

TriggerWorkflowRuleRequest & $Shape

TriggerWorkflowRuleRequest

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

---

decodeDelimited()

static decodeDelimited(reader): TriggerWorkflowRuleRequest & $Shape

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

Parameters

reader

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns

TriggerWorkflowRuleRequest & $Shape

TriggerWorkflowRuleRequest

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

Parameters

message

$Properties

TriggerWorkflowRuleRequest message or plain object to encode

writer?

Writer

Writer to encode to

Returns

Writer

Writer

---

encodeDelimited()

static encodeDelimited(message, writer?): Writer

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

Parameters

message

$Properties

TriggerWorkflowRuleRequest message or plain object to encode

writer?

Writer

Writer to encode to

Returns

Writer

Writer

---

fromObject()

static fromObject(object): TriggerWorkflowRuleRequest

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

Parameters

object

Plain object

Returns

TriggerWorkflowRuleRequest

TriggerWorkflowRuleRequest

---

toObject()

static toObject(message, options?): object

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

Parameters

message

TriggerWorkflowRuleRequest

TriggerWorkflowRuleRequest

options?

IConversionOptions

Conversion options

Returns

object

Plain object