export rule-set create

# Rules describe which files to process and how.
# Files will be exported using the first matching rule.
# If none of the rules match, the file will be skipped.
rules:

  # Flywheel container level to export files from
  # Impacts which Flywheel metadata fields are available for the path template.
  # For example, the path template cannot reference 'acquisition.label' when
  # exporting project level attachments.
  # Example: project
  # Default: acquisition
- level: acquisition

  # Include filter list
  # When given, only export files that match at least one include filter.
  # Files not matching any of the filters will be skipped by this rule.
  # Fields: path, dir, name, ext, depth, ctime, mtime
  # Operators: =, =~, <, >, <=, >=, !=
  # The =~ operator uses a syntax similar to shell/glob wildcard patterns.
  # Example: ["type=dicom"]
  # Default: null
  include: null

  # Exclude filter list
  # When given, skip files that match one or more exclude filters.
  # Exclude filters take precedence over include filters.
  # Example: ["session.label=~test"]
  # Default: null
  exclude: null

  # Export file path template
  # Use Flywheel metadata fields to export files in the desired folder hierarchy.
  # The default template depends on the level and mirrors the Flywheel containers:
  # - project: {project.label}/{file.name}
  # - subject: {project.label}/{subject.label}/{file.name}
  # - session: {project.label}/{subject.label}/{session.label}/{file.name}
  # - acquisition: {project.label}/{subject.label}/{session.label}/{acquisition.label}/{file.name}

  # Example: "{project}/{subject}/{session}/{acquisition}/{file}"
  # Default: null
  path: null

  # Export metadata
  # Set to true to store .metadata.json alongside every data file.
  # Default: false
  metadata: false

  # Extract zipped files
  # Set to true to unzip archives (e.g.: dicom.zip) before exporting.
  # Default: false
  unzip: false

# Storage kind to use the rule set with (blob|dicom)
# Default: blob
storage_kind: blob

# Stop processing after reaching a failure threshold
# Default: null
fail_fast: null