Class: CreateWorkflowRuleRequest

workflowservice.v1.CreateWorkflowRuleRequest

Represents a CreateWorkflowRuleRequest.

Implements

• ICreateWorkflowRuleRequest

Constructors

constructor

• new CreateWorkflowRuleRequest(properties?): CreateWorkflowRuleRequest

Constructs a new CreateWorkflowRuleRequest.

Parameters

Name	Type	Description
properties?	ICreateWorkflowRuleRequest	Properties to set

Returns

CreateWorkflowRuleRequest

Properties

description

• description: string

Rule description.Will be stored with the rule.

Implementation of

ICreateWorkflowRuleRequest.description

---

forceScan

• forceScan: boolean

If true, the rule will be applied to the currently running workflows via batch job. If not set , the rule will only be applied when triggering condition is satisfied. visibility_query in the rule will be used to select the workflows to apply the rule to.

Implementation of

ICreateWorkflowRuleRequest.forceScan

---

identity

• identity: string

Identity of the actor who created the rule. Will be stored with the rule.

Implementation of

ICreateWorkflowRuleRequest.identity

---

namespace

• namespace: string

CreateWorkflowRuleRequest namespace.

Implementation of

ICreateWorkflowRuleRequest.namespace

---

requestId

• requestId: string

Used to de-dupe requests. Typically should be UUID.

Implementation of

ICreateWorkflowRuleRequest.requestId

---

spec

• Optional spec: null | IWorkflowRuleSpec

The rule specification .

Implementation of

ICreateWorkflowRuleRequest.spec

Methods

toJSON

▸ toJSON(): Object

Converts this CreateWorkflowRuleRequest to JSON.

Returns

Object

JSON object

---

create

▸ create(properties?): CreateWorkflowRuleRequest

Creates a new CreateWorkflowRuleRequest instance using the specified properties.

Parameters

Name	Type	Description
properties?	ICreateWorkflowRuleRequest	Properties to set

Returns

CreateWorkflowRuleRequest

CreateWorkflowRuleRequest instance

---

decode

▸ decode(reader, length?): CreateWorkflowRuleRequest

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

CreateWorkflowRuleRequest

CreateWorkflowRuleRequest

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

---

decodeDelimited

▸ decodeDelimited(reader): CreateWorkflowRuleRequest

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

Parameters

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

Returns

CreateWorkflowRuleRequest

CreateWorkflowRuleRequest

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

Parameters

Name	Type	Description
message	ICreateWorkflowRuleRequest	CreateWorkflowRuleRequest message or plain object to encode
writer?	Writer	Writer to encode to

Returns

Writer

Writer

---

encodeDelimited

▸ encodeDelimited(message, writer?): Writer

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

Parameters

Name	Type	Description
message	ICreateWorkflowRuleRequest	CreateWorkflowRuleRequest message or plain object to encode
writer?	Writer	Writer to encode to

Returns

Writer

Writer

---

fromObject

▸ fromObject(object): CreateWorkflowRuleRequest

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

Parameters

Name	Type	Description
object	Object	Plain object

Returns

CreateWorkflowRuleRequest

CreateWorkflowRuleRequest

---

getTypeUrl

▸ getTypeUrl(typeUrlPrefix?): string

Gets the default type url for CreateWorkflowRuleRequest

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 CreateWorkflowRuleRequest message. Also converts values to other types if specified.

Parameters

Name	Type	Description
message	CreateWorkflowRuleRequest	CreateWorkflowRuleRequest
options?	IConversionOptions	Conversion options

Returns

Object

Plain object