Class GuardrailTrace

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

The trace details used in the Guardrail.

See Also:

  • Method Details

    • action

      public final GuardrailAction action()

      The trace action details used with 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 trace action details used with the Guardrail.
      See Also:

    • actionAsString

      public final String actionAsString()

      The trace action details used with 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 trace action details used with the Guardrail.
      See Also:

    • traceId

      public final String traceId()

      The details of the trace Id used in the Guardrail Trace.

      Returns:
      The details of the trace Id used in the Guardrail Trace.

    • hasInputAssessments

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

    • inputAssessments

      public final List<GuardrailAssessment> inputAssessments()

      The details of the input assessments used in the Guardrail Trace.

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

      Returns:
      The details of the input assessments used in the Guardrail Trace.

    • hasOutputAssessments

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

    • outputAssessments

      public final List<GuardrailAssessment> outputAssessments()

      The details of the output assessments used in the Guardrail Trace.

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

      Returns:
      The details of the output assessments used in the Guardrail Trace.

    • metadata

      public final Metadata metadata()

      Contains information about the Guardrail output.

      Returns:
      Contains information about the Guardrail output.

    • toBuilder

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

    • builder

      public static GuardrailTrace.Builder builder()

    • serializableBuilderClass

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