fail.asciidoc 735 B

12345678910111213141516171819202122232425
  1. [[fail-processor]]
  2. === Fail Processor
  3. Raises an exception. This is useful for when
  4. you expect a pipeline to fail and want to relay a specific message
  5. to the requester.
  6. [[fail-options]]
  7. .Fail Options
  8. [options="header"]
  9. |======
  10. | Name | Required | Default | Description
  11. | `message` | yes | - | The error message thrown by the processor. Supports <<accessing-template-fields,template snippets>>.
  12. include::common-options.asciidoc[]
  13. |======
  14. [source,js]
  15. --------------------------------------------------
  16. {
  17. "fail": {
  18. "if" : "ctx.tags.contains('production') != true",
  19. "message": "The production tag is not present, found tags: {{tags}}"
  20. }
  21. }
  22. --------------------------------------------------
  23. // NOTCONSOLE