Skip to main content

Class: ActivityStartingTrigger

Activity trigger will be triggered when an activity is about to start.

Properties​

predicate​

predicate: string

Activity predicate is a SQL-like string filter parameter. It is used to match against workflow data. The following activity attributes are supported as part of the predicate:

  • ActivityType: An Activity Type is the mapping of a name to an Activity Definition..
  • ActivityId: The ID of the activity.
  • ActivityAttempt: The number attempts of the activity.
  • BackoffInterval: The current amount of time between scheduled attempts of the activity.
  • ActivityStatus: The status of the activity. Can be one of "Scheduled", "Started", "Paused".
  • TaskQueue: The name of the task queue the workflow specified that the activity should run on. Activity predicate support the following operators:
  • =, !=, >, >=, <, <=
  • AND, OR, ()
  • BETWEEN ... AND STARTS_WITH

Methods​

toJSON()​

toJSON(): object

Converts this ActivityStartingTrigger to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): ActivityStartingTrigger & $Properties

Creates a new ActivityStartingTrigger instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

ActivityStartingTrigger & $Properties

ActivityStartingTrigger instance

Call Signature​

static create(properties?): ActivityStartingTrigger

Creates a new ActivityStartingTrigger instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

ActivityStartingTrigger

ActivityStartingTrigger instance

decode()​

static decode(reader, length?): ActivityStartingTrigger & $Properties

Decodes an ActivityStartingTrigger 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​

ActivityStartingTrigger & $Properties

ActivityStartingTrigger

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): ActivityStartingTrigger & $Properties

Decodes an ActivityStartingTrigger message from the specified reader or buffer, length delimited.

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

ActivityStartingTrigger & $Properties

ActivityStartingTrigger

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

Parameters​

message​

$Properties

ActivityStartingTrigger message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

ActivityStartingTrigger message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): ActivityStartingTrigger

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

Parameters​

object​

Plain object

Returns​

ActivityStartingTrigger

ActivityStartingTrigger

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

ActivityStartingTrigger

ActivityStartingTrigger

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object