FailActivity interface

Pacote:

@azure/synapse-artifacts

Essa atividade falhará dentro de seu próprio escopo e produzirá uma mensagem de erro personalizada e um código de erro. A mensagem de erro e o código podem ser fornecidos como um literal de cadeia de caracteres ou como uma expressão que pode ser avaliada como uma cadeia de caracteres em tempo de execução. O escopo da atividade pode ser todo o pipeline ou uma atividade de controle (por exemplo, foreach, switch, até), se a atividade de falha estiver contida nele.

Extends

ControlActivity

Propriedades

errorCode	O código de erro que categoriza o tipo de erro da atividade Fail. Pode ser conteúdo dinâmico que é avaliado para uma cadeia de caracteres não vazia/em branco no tempo de execução. Type: string (ou Expression with resultType string).
message	A mensagem de erro que apareceu na atividade Fail. Pode ser conteúdo dinâmico que é avaliado para uma cadeia de caracteres não vazia/em branco no tempo de execução. Type: string (ou Expression with resultType string).
type	Discriminador polimórfico, que especifica os diferentes tipos que este objeto pode ser

Propriedades Herdadas

dependsOn	A atividade depende da condição.
description	Descrição da atividade.
name	Nome da atividade.
onInactiveMarkAs	Resultado do status da atividade quando o estado é definido como Inativo. Esta é uma propriedade opcional e, se não for fornecida quando a atividade estiver inativa, o status será Sucedido por padrão.
state	Estado da atividade. Esta é uma propriedade opcional e, se não for fornecida, o estado será Ativo por padrão.
userProperties	Propriedades do usuário da atividade.

Detalhes de Propriedade

errorCode

O código de erro que categoriza o tipo de erro da atividade Fail. Pode ser conteúdo dinâmico que é avaliado para uma cadeia de caracteres não vazia/em branco no tempo de execução. Type: string (ou Expression with resultType string).

errorCode: any

Valor de Propriedade

any

message

A mensagem de erro que apareceu na atividade Fail. Pode ser conteúdo dinâmico que é avaliado para uma cadeia de caracteres não vazia/em branco no tempo de execução. Type: string (ou Expression with resultType string).

message: any

Valor de Propriedade

any

type

Discriminador polimórfico, que especifica os diferentes tipos que este objeto pode ser

type: "Fail"

Valor de Propriedade

"Fail"

Detalhes da Propriedade Herdada

dependsOn

A atividade depende da condição.

dependsOn?: ActivityDependency[]

Valor de Propriedade

ActivityDependency[]

herdado deControlActivity.dependsOn

description

Descrição da atividade.

description?: string

Valor de Propriedade

string

herdado deControlActivity.description

name

Nome da atividade.

name: string

Valor de Propriedade

string

herdada deControlActivity.name

onInactiveMarkAs

Resultado do status da atividade quando o estado é definido como Inativo. Esta é uma propriedade opcional e, se não for fornecida quando a atividade estiver inativa, o status será Sucedido por padrão.

onInactiveMarkAs?: string

Valor de Propriedade

string

herdado deControlActivity.onInactiveMarkAs

state

Estado da atividade. Esta é uma propriedade opcional e, se não for fornecida, o estado será Ativo por padrão.

state?: string

Valor de Propriedade

string

herdado deControlActivity.state

userProperties

Propriedades do usuário da atividade.

userProperties?: UserProperty[]

Valor de Propriedade

UserProperty[]

herdado deControlActivity.userProperties