Política AssertCondition

Esta página aplica-se ao Apigee e ao Apigee Hybrid.

Veja a documentação do Apigee Edge.

Ícone de política

Vista geral

A política AssertCondition avalia uma declaração condicional no tempo de execução nos fluxos de pedidos ou respostas. Pode definir uma condição com base nas variáveis do fluxo e usar esta política para afirmar a condição. Uma condição é sempre avaliada como um valor booleano, verdadeiro ou falso. Para mais informações sobre como escrever uma declaração condicional, consulte a Referência de condições.

Após a avaliação da condição, a política AssertCondition armazena o resultado da avaliação na variável de fluxo assertcondition.policy-name.truthValue. Pode usar a variável de fluxo resultante nos seus pedidos de informações subsequentes ou na lógica orquestrada. Se uma condição for avaliada como verdadeira, o valor da variável é definido como true. Caso contrário, é false. Se tiver definido várias políticas de AssertCondition, o policy-name no nome da variável ajuda a identificar a variável de forma exclusiva.

Esta política é uma política padrão e pode ser implementada em qualquer tipo de ambiente. Para obter informações sobre os tipos de políticas e a disponibilidade com cada tipo de ambiente, consulte Tipos de políticas.

<AssertCondition>

Define uma política <AssertCondition>. Ao usar esta política, pode avaliar uma declaração condicional que tenha uma ou mais condições unidas por um operador lógico. Para ver informações sobre todos os operadores suportados numa condição, consulte o artigo Operadores.

O resultado de uma declaração condicional é um valor booleano que pode ser true ou false.
Valor predefinido N/A
Obrigatório? Obrigatória
Tipo Tipo complexo
Elemento principal N/A
Elementos subordinados <Condition>
<DisplayName>

A tabela seguinte apresenta uma descrição geral dos elementos subordinados de <AssertCondition>:

Elemento secundário Obrigatório? Descrição
<Condition> Sim Especifica a condição a avaliar.
<DisplayName> Opcional Um nome personalizado para a política.

O elemento <AssertCondition> usa a seguinte sintaxe:

Sintaxe

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<AssertCondition">
    <!-- Display name for this policy -->
    <DisplayName>DISPLAY_NAME</DisplayName>
    <!-- Assertion's condition where operators are defined -->
    <Condition>CONDITIONAL_STATEMENT</Condition>
</AssertCondition>

Exemplo

O exemplo seguinte verifica se a variável google.dialogflow.my-prefix.claimAmount é superior a 0 e inferior a 1000.

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<AssertCondition continueOnError="false" enabled="true"
        name="MyAssertCondition">
    <DisplayName>Assert My Condition</DisplayName>
    <Condition>(google.dialogflow.my-prefix.claimAmount > 0)
                and
               (google.dialogflow.my-prefix.claimAmount LesserThan 1000)</Condition>
</AssertCondition>

Neste exemplo:

  • Se o valor da variável google.dialogflow.my-prefix.claimAmount for 500, a condição é avaliada como verdadeira e, por isso, a variável assertcondition.MyAssertCondition.truthValue é definida como true.
  • No entanto, se o valor da variável google.dialogflow.my-prefix.claimAmount for 1200, a variável assertcondition.MyAssertCondition.truthValue é definida como false.

Este elemento tem os seguintes atributos comuns a todas as políticas:

Atributo Predefinição Obrigatório? Descrição
name N/A Obrigatório

O nome interno da política. O valor do atributo name pode conter letras, números, espaços, hífenes, sublinhados e pontos finais. Este valor não pode exceder 255 carateres.

Opcionalmente, use o elemento <DisplayName> para etiquetar a política no editor de proxy da IU de gestão com um nome diferente em linguagem natural.
continueOnError falso Opcional Definido como false para devolver um erro quando uma política falha. Este comportamento é o esperado para a maioria das políticas. Definido como true para que a execução do fluxo continue mesmo depois de uma política falhar. Veja também:
enabled verdadeiro Opcional Defina como true para aplicar a política. Defina como false para desativar a política. A política não é aplicada, mesmo que permaneça anexada a um fluxo.
async   falso Descontinuado Este atributo foi descontinuado.

Referência de elemento secundário

Esta secção descreve os elementos subordinados de <AssertCondition>.

<Condition>

Especifica a condição a avaliar. Para mais informações sobre como escrever uma declaração condicional no Apigee, consulte a Referência de condições.

Valor predefinido N/A
Obrigatório? Obrigatória
Tipo String
Elemento principal <AssertCondition>
Elementos subordinados Nenhum

<DisplayName>

Use em conjunto com o atributo name para etiquetar a política no editor de proxy da IU de gestão com um nome diferente e mais natural.

O elemento <DisplayName> é comum a todas as políticas.

Valor predefinido N/A
Obrigatório? Opcional. Se omitir <DisplayName>, é usado o valor do atributo name da política.
Tipo String
Elemento principal <PolicyElement>
Elementos subordinados Nenhum

O elemento <DisplayName> usa a seguinte sintaxe:

Sintaxe

<PolicyElement>
  <DisplayName>POLICY_DISPLAY_NAME</DisplayName>
  ...
</PolicyElement>

Exemplo

<PolicyElement>
  <DisplayName>My Validation Policy</DisplayName>
</PolicyElement>

O elemento <DisplayName> não tem atributos nem elementos subordinados.

Códigos de erro

Esta secção descreve os códigos de falha e as mensagens de erro devolvidas, bem como as variáveis de falha definidas pelo Apigee quando esta política aciona um erro. Estas informações são importantes para saber se está a desenvolver regras de falhas para tratar falhas. Para saber mais, consulte o artigo O que precisa de saber acerca dos erros de políticas e o artigo Processamento de falhas.

Erros de tempo de execução

Estes erros podem ocorrer quando a política é executada.

Código de falha Estado de HTTP Causa
steps.assertcondition.ConditionEvaluationFailed 500 Não foi possível avaliar a declaração condicional. Existem vários motivos para este erro, incluindo valores incorretos nas variáveis no momento da execução.

Erros de implementação

Estes erros podem ocorrer quando implementa um proxy que contém esta política.

Nome do erro Causa
InvalidCondition A política não conseguiu validar a declaração condicional. Pode haver vários motivos para este erro, incluindo condições com formato incorreto ou a utilização de operadores não suportados.

Variáveis de falha

Sempre que existem erros de execução numa política, o Apigee gera mensagens de erro. Pode ver estas mensagens de erro na resposta de erro. Muitas vezes, as mensagens de erro geradas pelo sistema podem não ser relevantes no contexto do seu produto. Pode personalizar as mensagens de erro com base no tipo de erro para tornar as mensagens mais significativas.

Para personalizar as mensagens de erro, pode usar regras de falhas ou a política RaiseFault. Para informações sobre as diferenças entre as regras de falhas e a política RaiseFault, consulte Regras de falhas vs. a política RaiseFault. Tem de verificar as condições através do elemento Condition nas regras de falhas e na política RaiseFault. O Apigee fornece variáveis de falhas exclusivas para cada política, e os valores das variáveis de falhas são definidos quando uma política aciona erros de tempo de execução. Ao usar estas variáveis, pode verificar condições de erro específicas e tomar as medidas adequadas. Para mais informações sobre a verificação das condições de erro, consulte o artigo Criar condições.

A tabela seguinte descreve as variáveis de falha específicas desta política.

Variáveis Onde Exemplo
fault.name="FAULT_NAME" FAULT_NAME é o nome da falha, conforme indicado na tabela Erros de tempo de execução. O nome da falha é a última parte do código de falha. fault.name Matches "ConditionEvaluationFailed"
AssertCondition.POLICY_NAME.failed POLICY_NAME é o nome especificado pelo utilizador da política que gerou a falha. AssertCondition.My-AssertCondition.failed = true
Para mais informações sobre erros de políticas, consulte o artigo O que precisa de saber sobre erros de políticas.