Skip to main content

Class: WorkflowRule

WorkflowRule describes a rule that can be applied to any workflow in this namespace.

Properties​

createdByIdentity​

createdByIdentity: string

Identity of the actor that created the rule (-- api-linter: core::0140::prepositions=disabled aip.dev/not-precedent: It is better reflect the intent this way, we will also have updated_by. --) (-- api-linter: core::0142::time-field-names=disabled aip.dev/not-precedent: Same as above. All other options sounds clumsy --)

createTime?​

optional createTime?: $Properties | null

Rule creation time.

description​

description: string

Rule description.

spec?​

optional spec?: $Properties | null

Rule specification

Methods​

toJSON()​

toJSON(): object

Converts this WorkflowRule to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): WorkflowRule & $Shape

Creates a new WorkflowRule instance using the specified properties.

Parameters​
properties?​

$Shape

Properties to set

Returns​

WorkflowRule & $Shape

WorkflowRule instance

Call Signature​

static create(properties?): WorkflowRule

Creates a new WorkflowRule instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

WorkflowRule

WorkflowRule instance

decode()​

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

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

WorkflowRule & $Shape

WorkflowRule

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): WorkflowRule & $Shape

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

WorkflowRule & $Shape

WorkflowRule

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

Parameters​

message​

$Properties

WorkflowRule message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

WorkflowRule message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): WorkflowRule

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

Parameters​

object​

Plain object

Returns​

WorkflowRule

WorkflowRule

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

WorkflowRule

WorkflowRule

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object