Class: ActivityStartingTrigger
v1.WorkflowRuleSpec.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
▸ create(properties?): ActivityStartingTrigger & $Properties
Creates a new ActivityStartingTrigger instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | $Properties | Properties to set |
Returns
ActivityStartingTrigger & $Properties
ActivityStartingTrigger instance
▸ create(properties?): ActivityStartingTrigger
Parameters
| Name | Type |
|---|---|
properties? | $Properties |
Returns
decode
▸ decode(reader, length?): ActivityStartingTrigger & $Properties
Decodes an ActivityStartingTrigger 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
ActivityStartingTrigger & $Properties
ActivityStartingTrigger
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): ActivityStartingTrigger & $Properties
Decodes an ActivityStartingTrigger message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | 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
▸ encode(message, writer?): Writer
Encodes the specified ActivityStartingTrigger message. Does not implicitly temporal.api.rules.v1.WorkflowRuleSpec.ActivityStartingTrigger.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | ActivityStartingTrigger message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified ActivityStartingTrigger message, length delimited. Does not implicitly temporal.api.rules.v1.WorkflowRuleSpec.ActivityStartingTrigger.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | ActivityStartingTrigger message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): ActivityStartingTrigger
Creates an ActivityStartingTrigger message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
ActivityStartingTrigger
toObject
▸ toObject(message, options?): Object
Creates a plain object from an ActivityStartingTrigger message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | ActivityStartingTrigger | ActivityStartingTrigger |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object