Criterio AssertCondition

Norme standard

Questa pagina si applica ad Apigee e Apigee hybrid.

Visualizza la documentazione di Apigee Edge.

La policy AssertCondition valuta un'istruzione condizionale in fase di runtime nei flussi di richiesta o risposta. Puoi definire una condizione in base alle variabili di flusso e utilizzare questo criterio per asserire la condizione. Una condizione restituisce sempre un valore booleano, vero o falso. Per saperne di più sulla scrittura di un'istruzione condizionale, consulta Guida di riferimento alle condizioni.

Dopo aver valutato la condizione, il criterio AssertCondition memorizza il risultato della valutazione nella variabile di flusso assertcondition.policy-name.truthValue. Puoi utilizzare la variabile di flusso risultante nei callout o nella logica orchestrata successivi. Se una condizione restituisce il valore true, il valore della variabile viene impostato su true, altrimenti su false. Se hai definito più criteri AssertCondition, policy-name nel nome della variabile ti aiuta a identificarla in modo univoco.

Questa policy è una policy standard e può essere implementata in qualsiasi tipo di ambiente. Per informazioni sui tipi di policy e sulla disponibilità con ogni tipo di ambiente, consulta Tipi di policy.

<AssertCondition>

Definisce una policy <AssertCondition>. Utilizzando questo criterio, puoi valutare un'istruzione condizionale con una o più condizioni unite da un operatore logico. Per informazioni su tutti gli operatori supportati in una condizione, vedi Operatori.

Il risultato di un'istruzione condizionale è un valore booleano che può essere true o false.
Valore predefinito N/D
Obbligatorio? Obbligatorio
Tipo Tipo complesso
Elemento principale N/D
Elementi secondari <Condition>
<DisplayName>

La tabella seguente fornisce una descrizione generale degli elementi secondari di <AssertCondition>:

Elemento secondario Obbligatorio? Descrizione
<Condition> Sì Specifica la condizione da valutare.
<DisplayName> Facoltativo Un nome personalizzato per il criterio.

L'elemento <AssertCondition> utilizza la seguente sintassi:

Sintassi

<?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>

Esempio

Il seguente esempio controlla se la variabile google.dialogflow.my-prefix.claimAmount è maggiore di 0 e minore di 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>

In questo esempio:

  • Se il valore della variabile google.dialogflow.my-prefix.claimAmount è 500, la condizione restituisce true e quindi la variabile assertcondition.MyAssertCondition.truthValue è impostata su true.
  • Tuttavia, se il valore della variabile google.dialogflow.my-prefix.claimAmount è 1200, la variabile assertcondition.MyAssertCondition.truthValue è impostata su false.

Questo elemento ha i seguenti attributi comuni a tutti i criteri:

Attributo Predefinito Obbligatorio? Descrizione
name N/D Obbligatorio

Il nome interno del criterio. Il valore dell'attributo name può contenere lettere, numeri, spazi, trattini, trattini bassi e punti. Questo valore non può superare i 255 caratteri.

Se vuoi, utilizza l'elemento <DisplayName> per etichettare il criterio nell'editor proxy dell'interfaccia utente di gestione con un nome diverso in linguaggio naturale.
continueOnError falso Facoltativo Imposta su false per restituire un errore quando un criterio non va a buon fine. Questo è un comportamento previsto per la maggior parte dei criteri. Imposta su true per continuare l'esecuzione del flusso anche dopo un fallimento del criterio. Vedi anche:
enabled true Facoltativo Imposta su true per applicare il criterio. Imposta su false per disattivare il criterio. Il criterio non verrà applicato anche se rimane collegato a un flusso.
async   falso Ritirato Questo attributo è stato ritirato.

Riferimento all'elemento secondario

Questa sezione descrive gli elementi secondari di <AssertCondition>.

<Condition>

Specifica la condizione da valutare. Per saperne di più sulla scrittura di un'istruzione condizionale in Apigee, consulta Riferimento alle condizioni.

Valore predefinito N/D
Obbligatorio? Obbligatorio
Tipo Stringa
Elemento principale <AssertCondition>
Elementi secondari Nessuno

<DisplayName>

Da utilizzare insieme all'attributo name per etichettare il criterio nell'editor proxy dell'interfaccia utente di gestione con un nome diverso e più naturale.

L'elemento <DisplayName> è comune a tutti i criteri.

Valore predefinito N/D
Obbligatorio? Facoltativo. Se ometti <DisplayName>, viene utilizzato il valore dell'attributo name del criterio.
Tipo Stringa
Elemento principale <PolicyElement>
Elementi secondari Nessuno

La sintassi dell'elemento <DisplayName> è la seguente:

Sintassi

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

Esempio

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

L'elemento <DisplayName> non ha attributi o elementi secondari.

Codici di errore

This section describes the fault codes and error messages that are returned and fault variables that are set by Apigee when this policy triggers an error. This information is important to know if you are developing fault rules to handle faults. To learn more, see What you need to know about policy errors and Handling faults.

Runtime errors

These errors can occur when the policy executes.

Fault code HTTP status Cause
steps.assertcondition.ConditionEvaluationFailed 500 Failed to evaluate the conditional statement. There can be many reasons for this error, including incorrect values in the variables at run time.

Deployment errors

These errors can occur when you deploy a proxy containing this policy.

Error name Cause
InvalidCondition The policy was not able to validate the conditional statement. There can be many reasons for this error, including malformed conditions or use of unsupported operators.

Fault variables

Whenever there are execution errors in a policy, Apigee generates error messages. You can view these error messages in the error response. Many a time, system generated error messages might not be relevant in the context of your product. You might want to customize the error messages based on the type of error to make the messages more meaningful.

To customize the error messages, you can use either fault rules or the RaiseFault policy. For information about differences between fault rules and the RaiseFault policy, see FaultRules vs. the RaiseFault policy. You must check for conditions using the Condition element in both the fault rules and the RaiseFault policy. Apigee provides fault variables unique to each policy and the values of the fault variables are set when a policy triggers runtime errors. By using these variables, you can check for specific error conditions and take appropriate actions. For more information about checking error conditions, see Building conditions.

The following table describes the fault variables specific to this policy.

Variables Where Example
fault.name="FAULT_NAME" FAULT_NAME is the name of the fault, as listed in the Runtime errors table. The fault name is the last part of the fault code. fault.name Matches "ConditionEvaluationFailed"
AssertCondition.POLICY_NAME.failed POLICY_NAME is the user-specified name of the policy that threw the fault. AssertCondition.My-AssertCondition.failed = true
For more information about policy errors, see What you need to know about policy errors.