Class GuardrailPolicyResult

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

Per-policy guardrail assessment result. Captures which policy triggered, its outcome, and a policy-specific detail string.

See Also:

  • Method Details

    • policyType

      public final GuardrailPolicyType policyType()

      The type of guardrail policy that was evaluated.

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

      Returns:
      The type of guardrail policy that was evaluated.
      See Also:

    • policyTypeAsString

      public final String policyTypeAsString()

      The type of guardrail policy that was evaluated.

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

      Returns:
      The type of guardrail policy that was evaluated.
      See Also:

    • action

      public final GuardrailAction action()

      Outcome of this specific policy.

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

      Returns:
      Outcome of this specific policy.
      See Also:

    • actionAsString

      public final String actionAsString()

      Outcome of this specific policy.

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

      Returns:
      Outcome of this specific policy.
      See Also:

    • details

      public final String details()

      Policy-specific detail.

      Returns:
      Policy-specific detail.

    • toBuilder

      public GuardrailPolicyResult.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<GuardrailPolicyResult.Builder,GuardrailPolicyResult>
      Returns:
      a builder for type T

    • builder

      public static GuardrailPolicyResult.Builder builder()

    • serializableBuilderClass

      public static Class<? extends GuardrailPolicyResult.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)

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