WorkflowMetadata¶

Source definition: src/bitdrift/public/unary/workflows/v1/workflow_metadata.proto#L15-L57

Field	Type	Description
deployment_expiration	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	array of bitdrift.public.unary.workflows.v1.WorkflowMetadata.PerRuleMetadata up to 100 items	Metadata that applies to specific rules.
description	string up to 1000 chars	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¶

Source definition: src/bitdrift/public/unary/workflows/v1/workflow_metadata.proto#L16-L38

Field	Type	Description
fixed_time	bitdrift.public.unary.workflows.v1.WorkflowMetadata.DeploymentExpiration.FixedTime(Only one of fixed_time, or last_seen, disabled can be set)	The deployment expires after a fixed time.
last_seen	bitdrift.public.unary.workflows.v1.WorkflowMetadata.DeploymentExpiration.LastSeen(Only one of last_seen, or fixed_time, disabled can be set)	The deployment expires if the last seen time is older than the specified time.
disabled	bool(Only one of disabled, or fixed_time, last_seen can be set)	Disables expiration for the deployment.

Example¶

JSON

{
  "fixed_time": {
    "time": "3600s"
  }
}

WorkflowMetadata.DeploymentExpiration.FixedTime¶

Source definition: src/bitdrift/public/unary/workflows/v1/workflow_metadata.proto#L17-L20

Field	Type	Description
time	google.protobuf.Duration	The duration after which the deployment expires.

Example¶

JSON

{
  "time": "3600s"
}

WorkflowMetadata.DeploymentExpiration.LastSeen¶

Source definition: src/bitdrift/public/unary/workflows/v1/workflow_metadata.proto#L22-L25

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¶

Source definition: src/bitdrift/public/unary/workflows/v1/workflow_metadata.proto#L40-L46

Field	Type	Description
rule_id	string up to 100 chars	The rule ID this metadata applies to.
title	string up to 255 chars	The rule title displayed in the workflow graph.

Example¶

JSON

{
  "rule_id": "_i1yUnHjKfmWpCaD5Tazo",
  "title": "Rule title"
}