Class AgenticRetrieveGuardrailWarning

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

A warning generated by a guardrail during agentic retrieval.

See Also:

  • Method Details

    • action

      public final GuardrailAction action()

      The action taken by the guardrail.

      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:
      The action taken by the guardrail.
      See Also:

    • actionAsString

      public final String actionAsString()

      The action taken by the guardrail.

      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:
      The action taken by the guardrail.
      See Also:

    • id

      public final String id()

      The unique identifier of the guardrail.

      Returns:
      The unique identifier of the guardrail.

    • message

      public final String message()

      A message describing the guardrail evaluation result.

      Returns:
      A message describing the guardrail evaluation result.

    • version

      public final String version()

      The version of the guardrail.

      Returns:
      The version of the guardrail.

    • toBuilder

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

    • builder

      public static AgenticRetrieveGuardrailWarning.Builder builder()

    • serializableBuilderClass

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