Fail processor

Raises an exception. This is useful for when you expect a pipeline to fail and want to relay a specific message to the requester.

Table 16. Fail Options

NameRequiredDefaultDescription

message

yes

-

The error message thrown by the processor. Supports template snippets.

if

no

-

Conditionally execute this processor.

on_failure

no

-

Handle failures for this processor. See Handling Failures in Pipelines.

ignore_failure

no

false

Ignore failures for this processor. See Handling Failures in Pipelines.

tag

no

-

An identifier for this processor. Useful for debugging and metrics.

  1. {
  2.   "fail": {
  3.     "if" : "ctx.tags.contains('production') != true",
  4.     "message": "The production tag is not present, found tags: {{tags}}"
  5.   }
  6. }