github.com.argoproj.argo_events.pkg.apis.events.v1alpha1.DataFilter

DataFilter describes constraints and filters for event data.

CNCFContainersData ProcessingKubernetesMachine LearningOpen SourceWorkflow Engine

Properties

Name	Type	Description
comparator	string	Comparator compares the event data with a user given value. Can be ">=", ">", "=", "!=", "<", or "<=". Is optional, and if left blank treated as equality "=".
path	string	Path is the JSONPath of the event's (JSON decoded) data key. Path is a series of keys separated by a dot. A key may contain wildcard characters '*' and '?'. To access an array value use the index as t
template	string
type	string
value	array	Value is the allowed string values for this key. Booleans are parsed using strconv.ParseBool(), Numbers are parsed as float64 using strconv.ParseFloat(), Strings are treated as regular expressions, Ni

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/argo-workflows/refs/heads/main/json-schema/argo-workflows-github-com-argoproj-argo-events-pkg-apis-events-v1alpha1-data-filter-schema.json",
  "title": "github.com.argoproj.argo_events.pkg.apis.events.v1alpha1.DataFilter",
  "description": "DataFilter describes constraints and filters for event data.",
  "type": "object",
  "properties": {
    "comparator": {
      "description": "Comparator compares the event data with a user given value.\nCan be \">=\", \">\", \"=\", \"!=\", \"<\", or \"<=\".\nIs optional, and if left blank treated as equality \"=\".",
      "type": "string"
    },
    "path": {
      "description": "Path is the JSONPath of the event's (JSON decoded) data key.\nPath is a series of keys separated by a dot. A key may contain wildcard characters '*' and '?'.\nTo access an array value use the index as the key. The dot and wildcard characters can be escaped with '\\\\'.\nSee https://github.com/tidwall/gjson#path-syntax for more information on how to use this.",
      "type": "string"
    },
    "template": {
      "type": "string",
      "title": "Template is a go-template for extracting a string from the event's data.\nA Template is evaluated with provided path, type and value.\nThe templating follows the standard go-template syntax as well as sprig's extra functions.\nSee https://pkg.go.dev/text/template and https://masterminds.github.io/sprig/"
    },
    "type": {
      "type": "string",
      "title": "Type contains the JSON type of the data"
    },
    "value": {
      "description": "Value is the allowed string values for this key.\nBooleans are parsed using strconv.ParseBool(),\nNumbers are parsed as float64 using strconv.ParseFloat(),\nStrings are treated as regular expressions,\nNils value is ignored.",
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  }
}