Class: TriggerWorkflowRuleRequest

workflowservice.v1.TriggerWorkflowRuleRequest

Represents a TriggerWorkflowRuleRequest.

Implements

• ITriggerWorkflowRuleRequest

Constructors

constructor

• new TriggerWorkflowRuleRequest(properties?): TriggerWorkflowRuleRequest

Constructs a new TriggerWorkflowRuleRequest.

Parameters

Name	Type	Description
properties?	ITriggerWorkflowRuleRequest	Properties to set

Returns

TriggerWorkflowRuleRequest

Properties

execution

• Optional execution: null | IWorkflowExecution

Execution info of the workflow which scheduled this activity

Implementation of

ITriggerWorkflowRuleRequest.execution

---

id

• Optional id: null | string

TriggerWorkflowRuleRequest id.

Implementation of

ITriggerWorkflowRuleRequest.id

---

identity

• identity: string

The identity of the client who initiated this request

Implementation of

ITriggerWorkflowRuleRequest.identity

---

namespace

• namespace: string

TriggerWorkflowRuleRequest namespace.

Implementation of

ITriggerWorkflowRuleRequest.namespace

---

rule

• Optional rule: "id" | "spec"

Either provide id of existing rule, or rule specification

---

spec

• Optional spec: null | IWorkflowRuleSpec

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

Implementation of

ITriggerWorkflowRuleRequest.spec

Methods

toJSON

▸ toJSON(): Object

Converts this TriggerWorkflowRuleRequest to JSON.

Returns

Object

JSON object

---

create

▸ create(properties?): TriggerWorkflowRuleRequest

Creates a new TriggerWorkflowRuleRequest instance using the specified properties.

Parameters

Name	Type	Description
properties?	ITriggerWorkflowRuleRequest	Properties to set

Returns

TriggerWorkflowRuleRequest

TriggerWorkflowRuleRequest instance

---

decode

▸ decode(reader, length?): TriggerWorkflowRuleRequest

Decodes a TriggerWorkflowRuleRequest message from the specified reader or buffer.

Parameters

Name	Type	Description
reader	Uint8Array | Reader	Reader or buffer to decode from
length?	number	Message length if known beforehand

Returns

TriggerWorkflowRuleRequest

TriggerWorkflowRuleRequest

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

---

decodeDelimited

▸ decodeDelimited(reader): TriggerWorkflowRuleRequest

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

Parameters

Name	Type	Description
reader	Uint8Array | Reader	Reader or buffer to decode from

Returns

TriggerWorkflowRuleRequest

TriggerWorkflowRuleRequest

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

---

encode

▸ encode(message, writer?): Writer

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

Parameters

Name	Type	Description
message	ITriggerWorkflowRuleRequest	TriggerWorkflowRuleRequest message or plain object to encode
writer?	Writer	Writer to encode to

Returns

Writer

Writer

---

encodeDelimited

▸ encodeDelimited(message, writer?): Writer

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

Parameters

Name	Type	Description
message	ITriggerWorkflowRuleRequest	TriggerWorkflowRuleRequest message or plain object to encode
writer?	Writer	Writer to encode to

Returns

Writer

Writer

---

fromObject

▸ fromObject(object): TriggerWorkflowRuleRequest

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

Parameters

Name	Type	Description
object	Object	Plain object

Returns

TriggerWorkflowRuleRequest

TriggerWorkflowRuleRequest

---

getTypeUrl

▸ getTypeUrl(typeUrlPrefix?): string

Gets the default type url for TriggerWorkflowRuleRequest

Parameters

Name	Type	Description
typeUrlPrefix?	string	your custom typeUrlPrefix(default "type.googleapis.com")

Returns

string

The default type url

---

toObject

▸ toObject(message, options?): Object

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

Parameters

Name	Type	Description
message	TriggerWorkflowRuleRequest	TriggerWorkflowRuleRequest
options?	IConversionOptions	Conversion options

Returns

Object

Plain object