Class GuardrailRegexConfig

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

The regular expression to configure for the AI Guardrail.

See Also:

  • Method Details

    • name

      public final String name()

      The name of the regular expression to configure for the AI Guardrail.

      Returns:
      The name of the regular expression to configure for the AI Guardrail.

    • description

      public final String description()

      The description of the regular expression to configure for the AI Guardrail.

      Returns:
      The description of the regular expression to configure for the AI Guardrail.

    • pattern

      public final String pattern()

      The regular expression pattern to configure for the AI Guardrail.

      Returns:
      The regular expression pattern to configure for the AI Guardrail.

    • action

      public final GuardrailSensitiveInformationAction action()

      The AI Guardrail action to configure when matching regular expression 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 AI Guardrail action to configure when matching regular expression is detected.
      See Also:

    • actionAsString

      public final String actionAsString()

      The AI Guardrail action to configure when matching regular expression 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 AI Guardrail action to configure when matching regular expression is detected.
      See Also:

    • toBuilder

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

    • builder

      public static GuardrailRegexConfig.Builder builder()

    • serializableBuilderClass

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