WorkflowMetadata¶
| Field | Type | Description |
|---|---|---|
| deployment_expiration | The expiration condition for the workflow's deployment. Otherwise known as TTL. If not set the deployment never expires. | |
| per_rule_metadata | Metadata that applies to specific rules. |
Example¶
JSON
{
"deployment_expiration": {
"fixed_time": {
"time": "3600s"
}
},
"per_rule_metadata": [
{
"rule_id": "actn_ghi789",
"title": "My Workflow"
}
]
}
WorkflowMetadata.DeploymentExpiration¶
| Field | Type | Description |
|---|---|---|
| fixed_time | The deployment expires after a fixed time. (Only one of fixed_time, or last_seen, disabled can be set) |
|
| last_seen | The deployment expires if the last seen time is older than the specified time. (Only one of last_seen, or fixed_time, disabled can be set) |
|
| disabled | bool | Disables expiration for the deployment. (Only one of disabled, or fixed_time, last_seen can be set) |
Example¶
JSON
{
"fixed_time": {
"time": "3600s"
}
}
WorkflowMetadata.DeploymentExpiration.FixedTime¶
| Field | Type | Description |
|---|---|---|
| time | google.protobuf.Duration | The duration after which the deployment expires. |
Example¶
JSON
{
"time": "3600s"
}
WorkflowMetadata.DeploymentExpiration.LastSeen¶
| Field | Type | Description |
|---|---|---|
| time | google.protobuf.Duration | The duration after which the deployment expires if the data from the workflow has not been seen for the specified time. |
Example¶
JSON
{
"time": "3600s"
}
WorkflowMetadata.PerRuleMetadata¶
| Field | Type | Description |
|---|---|---|
| rule_id | string | The rule ID this metadata applies to. |
| title | string | The rule's title. This is used to display the rule in the workflow graph. Used to increase workflow's readability. |
Example¶
JSON
{
"rule_id": "actn_ghi789",
"title": "My Workflow"
}