Skip to main content

Class: CreateWorkflowRuleRequest

Represents a CreateWorkflowRuleRequest.

Properties​

description​

description: string

Rule description.Will be stored with the rule.

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.

identity​

identity: string

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

namespace​

namespace: string

CreateWorkflowRuleRequest namespace.

requestId​

requestId: string

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

spec?​

optional spec?: $Properties | null

The rule specification .

Methods​

toJSON()​

toJSON(): object

Converts this CreateWorkflowRuleRequest to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): CreateWorkflowRuleRequest & $Shape

Creates a new CreateWorkflowRuleRequest instance using the specified properties.

Parameters​
properties?​

$Shape

Properties to set

Returns​

CreateWorkflowRuleRequest & $Shape

CreateWorkflowRuleRequest instance

Call Signature​

static create(properties?): CreateWorkflowRuleRequest

Creates a new CreateWorkflowRuleRequest instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

CreateWorkflowRuleRequest

CreateWorkflowRuleRequest instance

decode()​

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

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

CreateWorkflowRuleRequest & $Shape

CreateWorkflowRuleRequest

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): CreateWorkflowRuleRequest & $Shape

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

CreateWorkflowRuleRequest & $Shape

CreateWorkflowRuleRequest

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

Parameters​

message​

$Properties

CreateWorkflowRuleRequest message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

CreateWorkflowRuleRequest message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): CreateWorkflowRuleRequest

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

Parameters​

object​

Plain object

Returns​

CreateWorkflowRuleRequest

CreateWorkflowRuleRequest

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

CreateWorkflowRuleRequest

CreateWorkflowRuleRequest

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object