Política AssertCondition

Esta página se aplica a Apigee y Apigee Hybrid.

Consulta la documentación de Apigee Edge.

Descripción general

La política AssertCondition evalúa una declaración condicional en el entorno de ejecución en los flujos de solicitud o respuesta. Puedes definir una condición según las variables de flujo y usar esta política para confirmar la condición. Una condición siempre se evalúa como un valor booleano, ya sea verdadero o falso. Si quieres obtener más información para escribir una declaración condicional, consulta Referencia de condiciones.

Después de evaluar la condición, la política AssertCondition almacena el resultado de la evaluación en la variable de flujo assertcondition.policy-name.truthValue. Puedes usar la variable de flujo resultante en los textos destacados posteriores o la lógica organizada. Si una condición se evalúa como verdadera, el valor de la variable se establece en true, de lo contrario, en false. Si definiste varias políticas AssertCondition, el policy-name en el nombre de la variable te ayuda a identificar de forma única la variable.

Esta es una política estándar y se puede implementar en cualquier tipo de entorno. No todos los usuarios necesitan conocer los tipos de políticas y el entorno. Para obtener información sobre los tipos de políticas y la disponibilidad con cada tipo de entorno, consulta Tipos de políticas.

<AssertCondition>

Define una política <AssertCondition>. Con esta política, puedes evaluar una declaración condicional que tiene una o más condiciones unidas por un operador lógico. Para obtener información sobre todos los operadores compatibles en una condición, consulta Operadores.

El resultado de una declaración condicional es un booleano que puede ser true o false.

Valor predeterminado	N/A
¿Es obligatorio?	Obligatorio
Tipo	Tipo complejo
Elemento principal	N/A
Elementos secundarios	<Condition> <DisplayName>

En la siguiente tabla, se proporciona una descripción de alto nivel de los elementos secundarios de <AssertCondition>.

Elemento secundario	¿Es obligatorio?	Descripción
<Condition>	Sí	Especifica la condición que se evaluará.
<DisplayName>	Opcional	Un nombre personalizado para la política

El elemento <AssertCondition> usa la siguiente sintaxis:

Sintaxis

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

Ejemplo

En el siguiente ejemplo, se verifica si la variable google.dialogflow.my-prefix.claimAmount es mayor que 0 y 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>

En este ejemplo:

• Si el valor de la variable google.dialogflow.my-prefix.claimAmount es 500, la condición se evalúa como verdadera y, por lo tanto, la variable assertcondition.MyAssertCondition.truthValue se establece en true.
• Sin embargo, si el valor de la variable google.dialogflow.my-prefix.claimAmount es 1,200, la variable assertcondition.MyAssertCondition.truthValue se establece en false.

Este elemento tiene los siguientes atributos que son comunes a todas las políticas:

Atributo	Predeterminada	(obligatorio)	Descripción
name	N/A	Obligatorio	El nombre interno de la política. El valor del atributo name puede contener letras, números, espacios, guiones, guiones bajos y puntos. Este valor no puede superar los 255 caracteres. De forma opcional, usa el elemento <DisplayName> para etiquetar la política en el editor de proxy de la IU de administración con un nombre de lenguaje natural diferente.
continueOnError	falso	Opcional	Configúralo como false para mostrar un error cuando una política falla. Este es el comportamiento previsto para la mayoría de las políticas. Configúralo como true para continuar con la ejecución del flujo incluso después de que una política falle. También consulta: Las reglas de fallas se activan SOLAMENTE en un estado de error (sobre el continueOnError) Controla fallas dentro del flujo actual
enabled	true	Opcional	Configúralo como true para aplicar la política. Configúralo como false para desactivar la política. La política no se aplicará, incluso si permanece conectada a un flujo.
async	falso	Obsoleta	Este atributo dejó de estar disponible.

Referencia del elemento secundario

En esta sección, se describen los elementos secundarios de <AssertCondition>.

<Condition>

Especifica la condición que se evaluará. Si quieres obtener más información para escribir una declaración condicional en Apigee, consulta Referencia de condiciones.

Valor predeterminado	N/A
¿Es obligatorio?	Obligatorio
Tipo	String
Elemento principal	<AssertCondition>
Elementos secundarios	Ninguna

<DisplayName>

Se usan además del atributo name para etiquetar la política en el editor de proxy de la IU de administración con un nombre de lenguaje natural diferente.

El elemento <DisplayName> es común a todas las políticas.

Valor predeterminado	N/A
¿Es obligatorio?	Opcional. Si omites <DisplayName>, se usa el valor del atributo name de la política.
Tipo	String
Elemento principal	<PolicyElement>
Elementos secundarios	Ninguna

El elemento <DisplayName> usa la siguiente sintaxis:

Sintaxis

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

Ejemplo

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

El elemento <DisplayName> no tiene atributos ni elementos secundarios.

Códigos de error

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.