Argo Workflows · Schema

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

github.com.argoproj.argo_events.pkg.apis.events.v1alpha1.Trigger schema from Argo Workflows API

CNCFContainersData ProcessingKubernetesMachine LearningOpen SourceWorkflow Engine

Properties

Name Type Description
atLeastOnce boolean
dlqTrigger object
parameters array
policy object
rateLimit object
retryStrategy object
template object Template describes the trigger specification.
View JSON Schema on GitHub

JSON Schema

argo-workflows-github-com-argoproj-argo-events-pkg-apis-events-v1alpha1-trigger-schema.json Raw ↑
{
  "$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-trigger-schema.json",
  "title": "github.com.argoproj.argo_events.pkg.apis.events.v1alpha1.Trigger",
  "description": "github.com.argoproj.argo_events.pkg.apis.events.v1alpha1.Trigger schema from Argo Workflows API",
  "type": "object",
  "properties": {
    "atLeastOnce": {
      "type": "boolean",
      "title": "AtLeastOnce determines the trigger execution semantics.\nDefaults to false. Trigger execution will use at-most-once semantics.\nIf set to true, Trigger execution will switch to at-least-once semantics.\n+kubebuilder:default=false\n+optional"
    },
    "dlqTrigger": {
      "title": "If the trigger fails, it will retry up to the configured number of\nretries. If the maximum retries are reached and the trigger is set to\nexecute atLeastOnce, the dead letter queue (DLQ) trigger will be invoked if\nspecified.  Invoking the dead letter queue trigger helps prevent data\nloss.\n+optional",
      "$ref": "#/definitions/github.com.argoproj.argo_events.pkg.apis.events.v1alpha1.Trigger"
    },
    "parameters": {
      "type": "array",
      "title": "Parameters is the list of parameters applied to the trigger template definition",
      "items": {
        "$ref": "#/definitions/github.com.argoproj.argo_events.pkg.apis.events.v1alpha1.TriggerParameter"
      }
    },
    "policy": {
      "title": "Policy to configure backoff and execution criteria for the trigger\n+optional",
      "$ref": "#/definitions/github.com.argoproj.argo_events.pkg.apis.events.v1alpha1.TriggerPolicy"
    },
    "rateLimit": {
      "title": "Rate limit, default unit is Second\n+optional",
      "$ref": "#/definitions/github.com.argoproj.argo_events.pkg.apis.events.v1alpha1.RateLimit"
    },
    "retryStrategy": {
      "title": "Retry strategy, defaults to no retry\n+optional",
      "$ref": "#/definitions/github.com.argoproj.argo_events.pkg.apis.events.v1alpha1.Backoff"
    },
    "template": {
      "description": "Template describes the trigger specification.",
      "$ref": "#/definitions/github.com.argoproj.argo_events.pkg.apis.events.v1alpha1.TriggerTemplate"
    }
  }
}