Class GuardrailPiiEntity

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

The PII entity configured for the guardrail.

See Also:

  • Method Details

    • type

      public final GuardrailPiiEntityType type()

      The type of PII entity. For example, Social Security Number.

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

      Returns:
      The type of PII entity. For example, Social Security Number.
      See Also:

    • typeAsString

      public final String typeAsString()

      The type of PII entity. For example, Social Security Number.

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

      Returns:
      The type of PII entity. For example, Social Security Number.
      See Also:

    • action

      public final GuardrailSensitiveInformationAction action()

      The configured guardrail action when PII entity is detected.

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

      Returns:
      The configured guardrail action when PII entity is detected.
      See Also:

    • actionAsString

      public final String actionAsString()

      The configured guardrail action when PII entity is detected.

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

      Returns:
      The configured guardrail action when PII entity is detected.
      See Also:

    • inputAction

      public final GuardrailSensitiveInformationAction inputAction()

      The action to take when harmful content is detected in the input. Supported values include:

      • BLOCK – Block the content and replace it with blocked messaging.

      • ANONYMIZE – Mask the content and replace it with identifier tags.

      • NONE – Take no action but return detection information in the trace response.

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

      Returns:
      The action to take when harmful content is detected in the input. Supported values include:

      • BLOCK – Block the content and replace it with blocked messaging.

      • ANONYMIZE – Mask the content and replace it with identifier tags.

      • NONE – Take no action but return detection information in the trace response.

      See Also:

    • inputActionAsString

      public final String inputActionAsString()

      The action to take when harmful content is detected in the input. Supported values include:

      • BLOCK – Block the content and replace it with blocked messaging.

      • ANONYMIZE – Mask the content and replace it with identifier tags.

      • NONE – Take no action but return detection information in the trace response.

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

      Returns:
      The action to take when harmful content is detected in the input. Supported values include:

      • BLOCK – Block the content and replace it with blocked messaging.

      • ANONYMIZE – Mask the content and replace it with identifier tags.

      • NONE – Take no action but return detection information in the trace response.

      See Also:

    • outputAction

      public final GuardrailSensitiveInformationAction outputAction()

      The action to take when harmful content is detected in the output. Supported values include:

      • BLOCK – Block the content and replace it with blocked messaging.

      • ANONYMIZE – Mask the content and replace it with identifier tags.

      • NONE – Take no action but return detection information in the trace response.

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

      Returns:
      The action to take when harmful content is detected in the output. Supported values include:

      • BLOCK – Block the content and replace it with blocked messaging.

      • ANONYMIZE – Mask the content and replace it with identifier tags.

      • NONE – Take no action but return detection information in the trace response.

      See Also:

    • outputActionAsString

      public final String outputActionAsString()

      The action to take when harmful content is detected in the output. Supported values include:

      • BLOCK – Block the content and replace it with blocked messaging.

      • ANONYMIZE – Mask the content and replace it with identifier tags.

      • NONE – Take no action but return detection information in the trace response.

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

      Returns:
      The action to take when harmful content is detected in the output. Supported values include:

      • BLOCK – Block the content and replace it with blocked messaging.

      • ANONYMIZE – Mask the content and replace it with identifier tags.

      • NONE – Take no action but return detection information in the trace response.

      See Also:

    • inputEnabled

      public final Boolean inputEnabled()

      Indicates whether guardrail evaluation is enabled on the input. When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.

      Returns:
      Indicates whether guardrail evaluation is enabled on the input. When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.

    • outputEnabled

      public final Boolean outputEnabled()

      Indicates whether guardrail evaluation is enabled on the output. When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.

      Returns:
      Indicates whether guardrail evaluation is enabled on the output. When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.

    • toBuilder

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

    • builder

      public static GuardrailPiiEntity.Builder builder()

    • serializableBuilderClass

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