---
search:
exclude: true
---
# WorkflowMetadata
| Field | Type | Description |
|---|---|---|
| deployment_expiration | [bitdrift.public.unary.workflows.v1.WorkflowMetadata.DeploymentExpiration](#bitdrift.public.unary.workflows.v1.WorkflowMetadata.DeploymentExpiration){ title="bitdrift.public.unary.workflows.v1.WorkflowMetadata.DeploymentExpiration"} | The expiration condition for the workflow's deployment. Otherwise known as TTL. If not set the deployment never expires. |
| per_rule_metadata | repeated [bitdrift.public.unary.workflows.v1.WorkflowMetadata.PerRuleMetadata](#bitdrift.public.unary.workflows.v1.WorkflowMetadata.PerRuleMetadata){ title="bitdrift.public.unary.workflows.v1.WorkflowMetadata.PerRuleMetadata"} | Metadata that applies to specific rules. |
| description | string | A long-form description for the workflow. |
#### Example
```json
{
"deployment_expiration": {
"fixed_time": {
"time": "3600s"
}
},
"description": "Workflow description",
"per_rule_metadata": [
{
"rule_id": "_i1yUnHjKfmWpCaD5Tazo",
"title": "Rule title"
}
]
}
```
# WorkflowMetadata.DeploymentExpiration
| Field | Type | Description |
|---|---|---|
| fixed_time | [bitdrift.public.unary.workflows.v1.WorkflowMetadata.DeploymentExpiration.FixedTime](#bitdrift.public.unary.workflows.v1.WorkflowMetadata.DeploymentExpiration.FixedTime){ title="bitdrift.public.unary.workflows.v1.WorkflowMetadata.DeploymentExpiration.FixedTime"} | The deployment expires after a fixed time.
(Only one of fixed_time, or last_seen, disabled can be set) |
| last_seen | [bitdrift.public.unary.workflows.v1.WorkflowMetadata.DeploymentExpiration.LastSeen](#bitdrift.public.unary.workflows.v1.WorkflowMetadata.DeploymentExpiration.LastSeen){ title="bitdrift.public.unary.workflows.v1.WorkflowMetadata.DeploymentExpiration.LastSeen"} | 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](https://protobuf.dev/reference/protobuf/google.protobuf/#duration){ title="google.protobuf.Duration"} | The duration after which the deployment expires. |
#### Example
```json
{
"time": "3600s"
}
```
# WorkflowMetadata.DeploymentExpiration.LastSeen
| Field | Type | Description |
|---|---|---|
| time | [google.protobuf.Duration](https://protobuf.dev/reference/protobuf/google.protobuf/#duration){ title="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 title displayed in the workflow graph. |
#### Example
```json
{
"rule_id": "_i1yUnHjKfmWpCaD5Tazo",
"title": "Rule title"
}
```