Class GuardrailAutomatedReasoningFinding

java.lang.Object
software.amazon.awssdk.services.bedrockruntime.model.GuardrailAutomatedReasoningFinding
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<GuardrailAutomatedReasoningFinding.Builder,GuardrailAutomatedReasoningFinding>
@Generated("software.amazon.awssdk:codegen") public final class GuardrailAutomatedReasoningFinding extends Object implements SdkPojo, Serializable, ToCopyableBuilder<GuardrailAutomatedReasoningFinding.Builder,GuardrailAutomatedReasoningFinding>

Represents a logical validation result from automated reasoning policy evaluation. The finding indicates whether claims in the input are logically valid, invalid, satisfiable, impossible, or have other logical issues.

See Also:

  • Method Details

    • valid

      public final GuardrailAutomatedReasoningValidFinding valid()

      Contains the result when the automated reasoning evaluation determines that the claims in the input are logically valid and definitively true based on the provided premises and policy rules.

      Returns:
      Contains the result when the automated reasoning evaluation determines that the claims in the input are logically valid and definitively true based on the provided premises and policy rules.

    • invalid

      public final GuardrailAutomatedReasoningInvalidFinding invalid()

      Contains the result when the automated reasoning evaluation determines that the claims in the input are logically invalid and contradict the established premises or policy rules.

      Returns:
      Contains the result when the automated reasoning evaluation determines that the claims in the input are logically invalid and contradict the established premises or policy rules.

    • satisfiable

      public final GuardrailAutomatedReasoningSatisfiableFinding satisfiable()

      Contains the result when the automated reasoning evaluation determines that the claims in the input could be either true or false depending on additional assumptions not provided in the input context.

      Returns:
      Contains the result when the automated reasoning evaluation determines that the claims in the input could be either true or false depending on additional assumptions not provided in the input context.

    • impossible

      public final GuardrailAutomatedReasoningImpossibleFinding impossible()

      Contains the result when the automated reasoning evaluation determines that no valid logical conclusions can be drawn due to contradictions in the premises or policy rules themselves.

      Returns:
      Contains the result when the automated reasoning evaluation determines that no valid logical conclusions can be drawn due to contradictions in the premises or policy rules themselves.

    • translationAmbiguous

      public final GuardrailAutomatedReasoningTranslationAmbiguousFinding translationAmbiguous()

      Contains the result when the automated reasoning evaluation detects that the input has multiple valid logical interpretations, requiring additional context or clarification to proceed with validation.

      Returns:
      Contains the result when the automated reasoning evaluation detects that the input has multiple valid logical interpretations, requiring additional context or clarification to proceed with validation.

    • tooComplex

      public final GuardrailAutomatedReasoningTooComplexFinding tooComplex()

      Contains the result when the automated reasoning evaluation cannot process the input due to its complexity or volume exceeding the system's processing capacity for logical analysis.

      Returns:
      Contains the result when the automated reasoning evaluation cannot process the input due to its complexity or volume exceeding the system's processing capacity for logical analysis.

    • noTranslations

      public final GuardrailAutomatedReasoningNoTranslationsFinding noTranslations()

      Contains the result when the automated reasoning evaluation cannot extract any relevant logical information from the input that can be validated against the policy rules.

      Returns:
      Contains the result when the automated reasoning evaluation cannot extract any relevant logical information from the input that can be validated against the policy rules.

    • toBuilder

      public GuardrailAutomatedReasoningFinding.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<GuardrailAutomatedReasoningFinding.Builder,GuardrailAutomatedReasoningFinding>
      Returns:
      a builder for type T

    • builder

      public static GuardrailAutomatedReasoningFinding.Builder builder()

    • serializableBuilderClass

      public static Class<? extends GuardrailAutomatedReasoningFinding.Builder> serializableBuilderClass()

    • hashCode

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

    • equals

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

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)

    • fromValid

      public static GuardrailAutomatedReasoningFinding fromValid(GuardrailAutomatedReasoningValidFinding valid)
      Create an instance of this class with valid() initialized to the given value.

      Contains the result when the automated reasoning evaluation determines that the claims in the input are logically valid and definitively true based on the provided premises and policy rules.

      Parameters:
      valid - Contains the result when the automated reasoning evaluation determines that the claims in the input are logically valid and definitively true based on the provided premises and policy rules.

    • fromValid

      public static GuardrailAutomatedReasoningFinding fromValid(Consumer<GuardrailAutomatedReasoningValidFinding.Builder> valid)
      Create an instance of this class with valid() initialized to the given value.

      Contains the result when the automated reasoning evaluation determines that the claims in the input are logically valid and definitively true based on the provided premises and policy rules.

      Parameters:
      valid - Contains the result when the automated reasoning evaluation determines that the claims in the input are logically valid and definitively true based on the provided premises and policy rules.

    • fromInvalid

      public static GuardrailAutomatedReasoningFinding fromInvalid(GuardrailAutomatedReasoningInvalidFinding invalid)
      Create an instance of this class with invalid() initialized to the given value.

      Contains the result when the automated reasoning evaluation determines that the claims in the input are logically invalid and contradict the established premises or policy rules.

      Parameters:
      invalid - Contains the result when the automated reasoning evaluation determines that the claims in the input are logically invalid and contradict the established premises or policy rules.

    • fromInvalid

      public static GuardrailAutomatedReasoningFinding fromInvalid(Consumer<GuardrailAutomatedReasoningInvalidFinding.Builder> invalid)
      Create an instance of this class with invalid() initialized to the given value.

      Contains the result when the automated reasoning evaluation determines that the claims in the input are logically invalid and contradict the established premises or policy rules.

      Parameters:
      invalid - Contains the result when the automated reasoning evaluation determines that the claims in the input are logically invalid and contradict the established premises or policy rules.

    • fromSatisfiable

      public static GuardrailAutomatedReasoningFinding fromSatisfiable(GuardrailAutomatedReasoningSatisfiableFinding satisfiable)
      Create an instance of this class with satisfiable() initialized to the given value.

      Contains the result when the automated reasoning evaluation determines that the claims in the input could be either true or false depending on additional assumptions not provided in the input context.

      Parameters:
      satisfiable - Contains the result when the automated reasoning evaluation determines that the claims in the input could be either true or false depending on additional assumptions not provided in the input context.

    • fromSatisfiable

      public static GuardrailAutomatedReasoningFinding fromSatisfiable(Consumer<GuardrailAutomatedReasoningSatisfiableFinding.Builder> satisfiable)
      Create an instance of this class with satisfiable() initialized to the given value.

      Contains the result when the automated reasoning evaluation determines that the claims in the input could be either true or false depending on additional assumptions not provided in the input context.

      Parameters:
      satisfiable - Contains the result when the automated reasoning evaluation determines that the claims in the input could be either true or false depending on additional assumptions not provided in the input context.

    • fromImpossible

      public static GuardrailAutomatedReasoningFinding fromImpossible(GuardrailAutomatedReasoningImpossibleFinding impossible)
      Create an instance of this class with impossible() initialized to the given value.

      Contains the result when the automated reasoning evaluation determines that no valid logical conclusions can be drawn due to contradictions in the premises or policy rules themselves.

      Parameters:
      impossible - Contains the result when the automated reasoning evaluation determines that no valid logical conclusions can be drawn due to contradictions in the premises or policy rules themselves.

    • fromImpossible

      public static GuardrailAutomatedReasoningFinding fromImpossible(Consumer<GuardrailAutomatedReasoningImpossibleFinding.Builder> impossible)
      Create an instance of this class with impossible() initialized to the given value.

      Contains the result when the automated reasoning evaluation determines that no valid logical conclusions can be drawn due to contradictions in the premises or policy rules themselves.

      Parameters:
      impossible - Contains the result when the automated reasoning evaluation determines that no valid logical conclusions can be drawn due to contradictions in the premises or policy rules themselves.

    • fromTranslationAmbiguous

      public static GuardrailAutomatedReasoningFinding fromTranslationAmbiguous(GuardrailAutomatedReasoningTranslationAmbiguousFinding translationAmbiguous)
      Create an instance of this class with translationAmbiguous() initialized to the given value.

      Contains the result when the automated reasoning evaluation detects that the input has multiple valid logical interpretations, requiring additional context or clarification to proceed with validation.

      Parameters:
      translationAmbiguous - Contains the result when the automated reasoning evaluation detects that the input has multiple valid logical interpretations, requiring additional context or clarification to proceed with validation.

    • fromTranslationAmbiguous

      public static GuardrailAutomatedReasoningFinding fromTranslationAmbiguous(Consumer<GuardrailAutomatedReasoningTranslationAmbiguousFinding.Builder> translationAmbiguous)
      Create an instance of this class with translationAmbiguous() initialized to the given value.

      Contains the result when the automated reasoning evaluation detects that the input has multiple valid logical interpretations, requiring additional context or clarification to proceed with validation.

      Parameters:
      translationAmbiguous - Contains the result when the automated reasoning evaluation detects that the input has multiple valid logical interpretations, requiring additional context or clarification to proceed with validation.

    • fromTooComplex

      public static GuardrailAutomatedReasoningFinding fromTooComplex(GuardrailAutomatedReasoningTooComplexFinding tooComplex)
      Create an instance of this class with tooComplex() initialized to the given value.

      Contains the result when the automated reasoning evaluation cannot process the input due to its complexity or volume exceeding the system's processing capacity for logical analysis.

      Parameters:
      tooComplex - Contains the result when the automated reasoning evaluation cannot process the input due to its complexity or volume exceeding the system's processing capacity for logical analysis.

    • fromTooComplex

      public static GuardrailAutomatedReasoningFinding fromTooComplex(Consumer<GuardrailAutomatedReasoningTooComplexFinding.Builder> tooComplex)
      Create an instance of this class with tooComplex() initialized to the given value.

      Contains the result when the automated reasoning evaluation cannot process the input due to its complexity or volume exceeding the system's processing capacity for logical analysis.

      Parameters:
      tooComplex - Contains the result when the automated reasoning evaluation cannot process the input due to its complexity or volume exceeding the system's processing capacity for logical analysis.

    • fromNoTranslations

      public static GuardrailAutomatedReasoningFinding fromNoTranslations(GuardrailAutomatedReasoningNoTranslationsFinding noTranslations)
      Create an instance of this class with noTranslations() initialized to the given value.

      Contains the result when the automated reasoning evaluation cannot extract any relevant logical information from the input that can be validated against the policy rules.

      Parameters:
      noTranslations - Contains the result when the automated reasoning evaluation cannot extract any relevant logical information from the input that can be validated against the policy rules.

    • fromNoTranslations

      public static GuardrailAutomatedReasoningFinding fromNoTranslations(Consumer<GuardrailAutomatedReasoningNoTranslationsFinding.Builder> noTranslations)
      Create an instance of this class with noTranslations() initialized to the given value.

      Contains the result when the automated reasoning evaluation cannot extract any relevant logical information from the input that can be validated against the policy rules.

      Parameters:
      noTranslations - Contains the result when the automated reasoning evaluation cannot extract any relevant logical information from the input that can be validated against the policy rules.

    • type

      public GuardrailAutomatedReasoningFinding.Type type()
      Retrieve an enum value representing which member of this object is populated. When this class is returned in a service response, this will be GuardrailAutomatedReasoningFinding.Type.UNKNOWN_TO_SDK_VERSION if the service returned a member that is only known to a newer SDK version. When this class is created directly in your code, this will be GuardrailAutomatedReasoningFinding.Type.UNKNOWN_TO_SDK_VERSION if zero members are set, and null if more than one member is set.

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.