Todos os produtos
Search
Central de documentação

CloudFlow:Etapa fail

Última atualização: Aug 26, 2026

Este tópico descreve a etapa fail e apresenta exemplos de uso.

Introdução

A etapa fail encerra uma sequência de etapas antecipadamente, de forma semelhante às operações raise ou throw em linguagens de programação. Quando um fluxo executa essa etapa, as etapas subsequentes não são processadas. A etapa fail causa a falha da etapa pai. Essa falha se propaga para cima e resulta na falha de todo o fluxo.

Uma etapa fail tem as seguintes propriedades:

  • (Obrigatório) type: tipo da etapa. O valor deve ser fail.

  • (Obrigatório) name: nome da etapa.

  • (Opcional) error: tipo da falha.

  • (Opcional) cause: motivo da falha.

  • (Opcional) inputMappings: mapeamentos de entrada.

  • (Opcional) outputMappings: mapeamentos de saída.

Exemplo

A definição de fluxo a seguir usa uma etapa fail para interromper a execução prematuramente.

  • Se o valor de status na entrada for ready, o fluxo executa a etapa pass1 na primeira ramificação de escolha e, em seguida, a etapa final.

  • Caso o valor de status na entrada seja failed, o fluxo segue a instrução goto na segunda ramificação de escolha e executa a etapa handle_failure. Como handle_failure é uma etapa fail, o fluxo não executa a etapa final após handle_failure.

  • Quando a entrada não contém status ou seu valor difere de ready e failed, o fluxo executa as etapas padrão: pass2 e handle_failure.

version: v1
type: flow
steps:
  - type: choice
    name: mychoice
    choices:
      - condition: $.status == "ready"
        # choice with steps
        steps:
          - type: pass
            name: pass1
        goto: final
      - condition: $.status == "failed"
        goto: handle_failure
    default:
      # no need to use goto
      steps:
        - type: pass
          name: pass2
  - type: fail
    name: handle_failure
    error: StatusIsNotReady
    cause: status is not ready
  - type: pass
    name: final