Class GuardrailChecksSensitiveInformationResultEntry

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

The detection result for a single sensitive information entity found in the evaluated messages.

See Also:

  • Method Details

    • type

      public final GuardrailChecksSensitiveInformationEntityType type()

      The PII entity type that was detected.

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

      Returns:
      The PII entity type that was detected.
      See Also:

    • typeAsString

      public final String typeAsString()

      The PII entity type that was detected.

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

      Returns:
      The PII entity type that was detected.
      See Also:

    • confidenceScore

      public final Double confidenceScore()

      The confidence score for the detection, ranging from 0.0 to 1.0. Higher values indicate greater confidence.

      Returns:
      The confidence score for the detection, ranging from 0.0 to 1.0. Higher values indicate greater confidence.

    • beginOffset

      public final Integer beginOffset()

      The start character offset of the detected entity within the content block.

      Returns:
      The start character offset of the detected entity within the content block.

    • endOffset

      public final Integer endOffset()

      The end character offset of the detected entity within the content block.

      Returns:
      The end character offset of the detected entity within the content block.

    • messageIndex

      public final Integer messageIndex()

      The zero-based index of the message in the input messages array where the entity was detected.

      Returns:
      The zero-based index of the message in the input messages array where the entity was detected.

    • contentIndex

      public final Integer contentIndex()

      The zero-based index of the content block within the message where the entity was detected.

      Returns:
      The zero-based index of the content block within the message where the entity was detected.

    • toBuilder

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

    • builder

      public static GuardrailChecksSensitiveInformationResultEntry.Builder builder()

    • serializableBuilderClass

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