Argo Workflows · Schema

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

SFTPEventSource describes an event-source for sftp related events.

CNCFContainersData ProcessingKubernetesMachine LearningOpen SourceWorkflow Engine

Properties

Name Type Description
address object Address sftp address.
eventType string
filter object
metadata object
password object Password required for authentication if any.
pollIntervalDuration string
sshKeySecret object SSHKeySecret refers to the secret that contains SSH key. Key needs to contain private key and public key.
username object Username required for authentication if any.
watchPathConfig object
View JSON Schema on GitHub

JSON Schema

argo-workflows-github-com-argoproj-argo-events-pkg-apis-events-v1alpha1-sftp-event-source-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-sftp-event-source-schema.json",
  "title": "github.com.argoproj.argo_events.pkg.apis.events.v1alpha1.SFTPEventSource",
  "description": "SFTPEventSource describes an event-source for sftp related events.",
  "type": "object",
  "properties": {
    "address": {
      "description": "Address sftp address.",
      "$ref": "#/definitions/io.k8s.api.core.v1.SecretKeySelector"
    },
    "eventType": {
      "type": "string",
      "title": "Type of file operations to watch\nRefer https://github.com/fsnotify/fsnotify/blob/master/fsnotify.go for more information"
    },
    "filter": {
      "title": "Filter\n+optional",
      "$ref": "#/definitions/github.com.argoproj.argo_events.pkg.apis.events.v1alpha1.EventSourceFilter"
    },
    "metadata": {
      "type": "object",
      "title": "Metadata holds the user defined metadata which will passed along the event payload.\n+optional",
      "additionalProperties": {
        "type": "string"
      }
    },
    "password": {
      "description": "Password required for authentication if any.",
      "$ref": "#/definitions/io.k8s.api.core.v1.SecretKeySelector"
    },
    "pollIntervalDuration": {
      "type": "string",
      "title": "PollIntervalDuration the interval at which to poll the SFTP server\ndefaults to 10 seconds\n+optional"
    },
    "sshKeySecret": {
      "description": "SSHKeySecret refers to the secret that contains SSH key. Key needs to contain private key and public key.",
      "$ref": "#/definitions/io.k8s.api.core.v1.SecretKeySelector"
    },
    "username": {
      "description": "Username required for authentication if any.",
      "$ref": "#/definitions/io.k8s.api.core.v1.SecretKeySelector"
    },
    "watchPathConfig": {
      "title": "WatchPathConfig contains configuration about the file path to watch",
      "$ref": "#/definitions/github.com.argoproj.argo_events.pkg.apis.events.v1alpha1.WatchPathConfig"
    }
  }
}