Skip to main content

Class: BatchOperationTriggerWorkflowRule

BatchOperationTriggerWorkflowRule sends TriggerWorkflowRule requests to batch workflows.

Properties​

id?​

optional id?: string | null

ID of existing rule.

identity​

identity: string

The identity of the worker/client.

rule?​

optional rule?: "id" | "spec"

BatchOperationTriggerWorkflowRule rule.

spec?​

optional spec?: $Properties | null

Rule specification to be applied to the workflow without creating a new rule.

Methods​

toJSON()​

toJSON(): object

Converts this BatchOperationTriggerWorkflowRule to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): BatchOperationTriggerWorkflowRule & $Shape

Creates a new BatchOperationTriggerWorkflowRule instance using the specified properties.

Parameters​
properties?​

$Shape

Properties to set

Returns​

BatchOperationTriggerWorkflowRule & $Shape

BatchOperationTriggerWorkflowRule instance

Call Signature​

static create(properties?): BatchOperationTriggerWorkflowRule

Creates a new BatchOperationTriggerWorkflowRule instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

BatchOperationTriggerWorkflowRule

BatchOperationTriggerWorkflowRule instance

decode()​

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

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

BatchOperationTriggerWorkflowRule & $Shape

BatchOperationTriggerWorkflowRule

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): BatchOperationTriggerWorkflowRule & $Shape

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

BatchOperationTriggerWorkflowRule & $Shape

BatchOperationTriggerWorkflowRule

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

Parameters​

message​

$Properties

BatchOperationTriggerWorkflowRule message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

BatchOperationTriggerWorkflowRule message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): BatchOperationTriggerWorkflowRule

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

Parameters​

object​

Plain object

Returns​

BatchOperationTriggerWorkflowRule

BatchOperationTriggerWorkflowRule

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

BatchOperationTriggerWorkflowRule

BatchOperationTriggerWorkflowRule

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object