Class AutomatedReasoningPolicyScenario

    • Method Detail

      • expression

        public final String expression()

        The logical expression or condition that defines this test scenario.

        Returns:
        The logical expression or condition that defines this test scenario.
      • alternateExpression

        public final String alternateExpression()

        An alternative way to express the same test scenario, used for validation and comparison purposes.

        Returns:
        An alternative way to express the same test scenario, used for validation and comparison purposes.
      • hasRuleIds

        public final boolean hasRuleIds()
        For responses, this returns true if the service returned a value for the RuleIds property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
      • ruleIds

        public final List<String> ruleIds()

        The list of rule identifiers that are expected to be triggered or evaluated by this test scenario.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasRuleIds() method.

        Returns:
        The list of rule identifiers that are expected to be triggered or evaluated by this test scenario.
      • expectedResultAsString

        public final String expectedResultAsString()

        The expected outcome when this scenario is evaluated against the policy (e.g., PASS, FAIL, VIOLATION).

        If the service returns an enum value that is not available in the current SDK version, expectedResult will return AutomatedReasoningCheckResult.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from expectedResultAsString().

        Returns:
        The expected outcome when this scenario is evaluated against the policy (e.g., PASS, FAIL, VIOLATION).
        See Also:
        AutomatedReasoningCheckResult
      • hashCode

        public final int hashCode()
        Overrides:
        hashCode in class Object
      • equals

        public final boolean equals​(Object obj)
        Overrides:
        equals in class Object
      • toString

        public final String toString()
        Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
        Overrides:
        toString in class Object
      • getValueForField

        public final <T> Optional<T> getValueForField​(String fieldName,
                                                      Class<T> clazz)