Class AutomatedReasoningPolicyDefinitionQualityReport

    • Method Detail

      • typeCount

        public final Integer typeCount()

        The total number of custom types defined in the policy.

        Returns:
        The total number of custom types defined in the policy.
      • variableCount

        public final Integer variableCount()

        The total number of variables defined in the policy.

        Returns:
        The total number of variables defined in the policy.
      • ruleCount

        public final Integer ruleCount()

        The total number of rules defined in the policy.

        Returns:
        The total number of rules defined in the policy.
      • hasUnusedTypes

        public final boolean hasUnusedTypes()
        For responses, this returns true if the service returned a value for the UnusedTypes 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.
      • unusedTypes

        public final List<String> unusedTypes()

        A list of custom types that are defined but not referenced by any variables or rules, suggesting they may be unnecessary.

        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 hasUnusedTypes() method.

        Returns:
        A list of custom types that are defined but not referenced by any variables or rules, suggesting they may be unnecessary.
      • hasUnusedTypeValues

        public final boolean hasUnusedTypeValues()
        For responses, this returns true if the service returned a value for the UnusedTypeValues 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.
      • unusedTypeValues

        public final List<AutomatedReasoningPolicyDefinitionTypeValuePair> unusedTypeValues()

        A list of type values that are defined but never used in any rules, indicating potential cleanup opportunities.

        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 hasUnusedTypeValues() method.

        Returns:
        A list of type values that are defined but never used in any rules, indicating potential cleanup opportunities.
      • hasUnusedVariables

        public final boolean hasUnusedVariables()
        For responses, this returns true if the service returned a value for the UnusedVariables 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.
      • unusedVariables

        public final List<String> unusedVariables()

        A list of variables that are defined but not referenced by any rules, suggesting they may be unnecessary.

        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 hasUnusedVariables() method.

        Returns:
        A list of variables that are defined but not referenced by any rules, suggesting they may be unnecessary.
      • hasConflictingRules

        public final boolean hasConflictingRules()
        For responses, this returns true if the service returned a value for the ConflictingRules 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.
      • conflictingRules

        public final List<String> conflictingRules()

        A list of rules that may conflict with each other, potentially leading to inconsistent policy behavior.

        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 hasConflictingRules() method.

        Returns:
        A list of rules that may conflict with each other, potentially leading to inconsistent policy behavior.
      • hasDisjointRuleSets

        public final boolean hasDisjointRuleSets()
        For responses, this returns true if the service returned a value for the DisjointRuleSets 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.
      • disjointRuleSets

        public final List<AutomatedReasoningPolicyDisjointRuleSet> disjointRuleSets()

        Groups of rules that operate on completely separate sets of variables, indicating the policy may be addressing multiple unrelated concerns.

        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 hasDisjointRuleSets() method.

        Returns:
        Groups of rules that operate on completely separate sets of variables, indicating the policy may be addressing multiple unrelated concerns.
      • 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)