Política AssertCondition

Esta página se aplica à Apigee e à Apigee híbrida.

Confira a documentação da Apigee Edge.

Ícone da política

Visão geral

A política AssertCondition avalia uma instrução condicional do ambiente de execução nos fluxos de solicitação ou resposta. É possível definir uma condição com base nas variáveis de fluxo e usar essa política para declarar a condição. Uma condição sempre é avaliada como um valor booleano, verdadeiro ou falso. Para mais informações sobre como escrever uma instrução condicional, consulte Referência de condições.

Depois de avaliar a condição, a política AssertCondition armazena o resultado da avaliação na variável de fluxo assertcondition.policy-name.truthValue. É possível usar a variável de fluxo resultante nas chamadas subsequentes ou na lógica orquestrada. Se uma condição for avaliada como verdadeira, o valor da variável será definido como true. Caso contrário, como false. Se você definiu várias políticas AssertCondition, o policy-name no nome da variável ajudará a identificá-la de maneira exclusiva.

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

`<AssertCondition>`

Define uma política <AssertCondition>. Ao usar essa política, é possível avaliar uma instrução condicional que tenha uma ou mais condições mescladas por um operador lógico. Para mais informações sobre todos os operadores compatíveis em uma condição, consulte Operadores.

O resultado de uma instrução condicional é um booleano que pode ser um true ou um false.

Valor padrão	N/A
Obrigatório?	Obrigatório
Tipo	Tipo complexo
Elemento pai	N/A
Elemento filho	`<Condition>` `<DisplayName>`

A tabela a seguir fornece uma descrição de alto nível dos elementos-filhos de <AssertCondition>:

Elemento filho	Obrigatório?	Descrição
`<Condition>`	Sim	Especifica a condição a ser avaliada.
`<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 a seguir verifica se a variável google.dialogflow.my-prefix.claimAmount é maior que 0 e menor que 1.000.

<?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 será avaliada como verdadeira e, portanto, a variável assertcondition.MyAssertCondition.truthValue será definida como true.
No entanto, se o valor da variável google.dialogflow.my-prefix.claimAmount for 1200, a variável assertcondition.MyAssertCondition.truthValue será definida como false.

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

Atributo	Padrão	Obrigatório?	Descrição
`name`	N/A	Valor	O nome interno da política. O valor do atributo `name` pode conter letras, números, espaços, hifens, sublinhados e pontos. Esse valor não pode exceder 255 caracteres. Opcionalmente, use o elemento `<DisplayName>` para rotular a política no editor de proxy da IU de gerenciamento com um nome de linguagem natural diferente.
`continueOnError`	falso	Opcional	Defina como `false` para retornar um erro quando uma política falhar. Esse é o comportamento esperado para a maioria das políticas. Defina como `true` para que a execução do fluxo continue, mesmo depois que uma política falhar. Consulte também: As regras de falha são acionadas SOMENTE em um estado de erro (sobre continueOnError) Como corrigir falhas no fluxo atual
`enabled`	true	Opcional	Defina como `true` para aplicar a política. Defina como `false` para desativar a política. A política não será aplicada mesmo que permaneça vinculada a um fluxo.
`async`	falso	Obsoleto	Esse atributo está obsoleto.

Referência a elementos filhos

Esta seção descreve os elementos filhos de <AssertCondition>.

`<Condition>`

Especifica a condição a ser avaliada. Para mais informações sobre como escrever uma instrução condicional na Apigee, consulte Referência de condições.

Valor padrão	N/A
Obrigatório?	Obrigatório
Tipo	String
Elemento pai	`<AssertCondition>`
Elemento filho	Nenhum

`<DisplayName>`

Use além do atributo name para rotular a política no editor de proxy da IU de gerenciamento com um nome de som diferente e mais natural.

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

Valor padrão	N/A
Obrigatório?	Opcional. Se você omitir `<DisplayName>`, o valor do atributo `name` da política será usado
Tipo	String
Elemento pai	<`PolicyElement`>
Elemento filho	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 ou elementos filhos.

Códigos de erro

Esta seção descreve os códigos de falha e as mensagens de erro que são retornadas e as variáveis de falha definidas pela Apigee quando essa política aciona um erro. Essas informações são importantes para saber se você está desenvolvendo regras de falha para lidar com falhas. Para saber mais, consulte O que você precisa saber sobre erros de política e Como lidar com falhas.

Erros de execução

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

Código de falha	Status HTTP	Causa
`steps.assertcondition.ConditionEvaluationFailed`	`500`	Falha ao avaliar a instrução condicional. Pode haver muitos motivos para esse erro, incluindo valores incorretos nas variáveis no ambiente de execução.

Erros na implantação

Esses erros podem ocorrer quando você implanta um proxy que contém esta política.

Nome do erro	Causa
`InvalidCondition`	A política não conseguiu validar a instrução condicional. Pode haver muitos motivos para esse erro, incluindo condições malformadas ou uso de operadores não aceitos.

Variáveis de falha

Sempre que houver erros de execução em uma política, a Apigee gerará mensagens de erro. Essas mensagens de erro podem ser visualizadas na resposta de erro. Muitas vezes, as mensagens de erro geradas pelo sistema podem não ser relevantes no contexto do produto. Personalize as mensagens de erro com base no tipo específico para torná-las mais úteis.

Para personalizar as mensagens de erro, use regras de falha ou a política RaiseFault. Para informações sobre as diferenças entre as regras de falha e a política RaiseFault, consulte FaultRules vs. a política RaiseFault. Verifique as condições usando o elemento Condition nas regras de falha e na política RaiseFault. A Apigee fornece variáveis de falha exclusivas para cada política, e os valores das variáveis de falha são definidos quando uma política aciona erros de ambiente de execução. Ao usar essas variáveis, é possível verificar se há condições de erro específicas e agir conforme adequado. Para mais informações sobre como verificar condições de erro, consulte Como criar condições.

A tabela a seguir descreve as variáveis de falha específicas da política.

Variáveis	Onde	Exemplo
`fault.name="FAULT_NAME"`	`FAULT_NAME` é o nome da falha, conforme listado na tabela Erros do ambiente 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 da política especificada pelo usuário que gerou a falha.	`AssertCondition.My-AssertCondition.failed = true`

Para mais informações sobre erros de política, consulte O que você precisa saber sobre erros de política.