Skip to content

Schema Reference

Dataflow Example

The following YAML shows the typical for used for basic dataflows.

name: my_dataflow
notes: |
    Description goes here.

variables:
    var1: "string"

steps:
  - name: first_step
    notes: Display console message.
    params:
        output: |
            One small step for dataflows....

Definitions

name

String used as a reference for a pipeline, stage, job, or step.

notes

String used to provide additional detail explaining what a dataflow is used for.

variables

Name/value pairs used to defined variables for a pipeline, stage, job or step.

pipelines

Assembly of jobs to be run, potentially organized in stages.

stages

Grouping used to organize jobs.

jobs

Collection of steps.

steps

Steps are a linear sequence of operations that make up a job.