Argo Workflows · JSON Structure

Argo Workflows Github Com Argoproj Argo Events Pkg Apis Events V1Alpha1 Kafka Event Source Structure

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

Type: object Properties: 14
CNCFContainersData ProcessingKubernetesMachine LearningOpen SourceWorkflow Engine

github.com.argoproj.argo_events.pkg.apis.events.v1alpha1.KafkaEventSource is a JSON Structure definition published by Argo Workflows, describing 14 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

config connectionBackoff consumerGroup filter jsonBody limitEventsPerSecond metadata partition sasl schemaRegistry tls topic url version

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/argo-workflows/refs/heads/main/json-structure/argo-workflows-github-com-argoproj-argo-events-pkg-apis-events-v1alpha1-kafka-event-source-structure.json",
  "name": "github.com.argoproj.argo_events.pkg.apis.events.v1alpha1.KafkaEventSource",
  "description": "github.com.argoproj.argo_events.pkg.apis.events.v1alpha1.KafkaEventSource schema from Argo Workflows API",
  "type": "object",
  "properties": {
    "config": {
      "description": "Yaml format Sarama config for Kafka connection.\nIt follows the struct of sarama.Config. See https://github.com/IBM/sarama/blob/main/config.go\ne.g.\n\nconsumer:\n  fetch:\n    min: 1\nnet:\n  MaxOpenRequests: 5\n\n+optional",
      "type": "string"
    },
    "connectionBackoff": {
      "description": "Backoff holds parameters applied to connection.",
      "$ref": "#/definitions/github.com.argoproj.argo_events.pkg.apis.events.v1alpha1.Backoff"
    },
    "consumerGroup": {
      "name": "Consumer group for kafka client\n+optional",
      "$ref": "#/definitions/github.com.argoproj.argo_events.pkg.apis.events.v1alpha1.KafkaConsumerGroup"
    },
    "filter": {
      "name": "Filter\n+optional",
      "$ref": "#/definitions/github.com.argoproj.argo_events.pkg.apis.events.v1alpha1.EventSourceFilter"
    },
    "jsonBody": {
      "type": "boolean",
      "name": "JSONBody specifies that all event body payload coming from this\nsource will be JSON\n+optional"
    },
    "limitEventsPerSecond": {
      "type": "string",
      "name": "Sets a limit on how many events get read from kafka per second.\n+optional"
    },
    "metadata": {
      "type": "object",
      "name": "Metadata holds the user defined metadata which will passed along the event payload.\n+optional",
      "additionalProperties": {
        "type": "string"
      }
    },
    "partition": {
      "type": "string",
      "name": "Partition name\n+optional"
    },
    "sasl": {
      "name": "SASL configuration for the kafka client\n+optional",
      "$ref": "#/definitions/github.com.argoproj.argo_events.pkg.apis.events.v1alpha1.SASLConfig"
    },
    "schemaRegistry": {
      "name": "Schema Registry configuration for consumer message with Avro format\n+optional",
      "$ref": "#/definitions/github.com.argoproj.argo_events.pkg.apis.events.v1alpha1.SchemaRegistryConfig"
    },
    "tls": {
      "name": "TLS configuration for the kafka client.\n+optional",
      "$ref": "#/definitions/github.com.argoproj.argo_events.pkg.apis.events.v1alpha1.TLSConfig"
    },
    "topic": {
      "type": "string",
      "name": "Topic name"
    },
    "url": {
      "type": "string",
      "name": "URL to kafka cluster, multiple URLs separated by comma"
    },
    "version": {
      "type": "string",
      "name": "Specify what kafka version is being connected to enables certain features in sarama, defaults to 1.0.0\n+optional"
    }
  }
}