Class GuardrailCustomWord

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

A custom word configured in a guardrail.

See Also:

  • Method Details

    • match

      public final String match()

      The match for the custom word.

      Returns:
      The match for the custom word.

    • action

      public final GuardrailWordPolicyAction action()

      The action for the custom word.

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

      Returns:
      The action for the custom word.
      See Also:

    • actionAsString

      public final String actionAsString()

      The action for the custom word.

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

      Returns:
      The action for the custom word.
      See Also:

    • detected

      public final Boolean detected()

      Indicates whether custom word content that breaches the guardrail configuration is detected.

      Returns:
      Indicates whether custom word content that breaches the guardrail configuration is detected.

    • toBuilder

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

    • builder

      public static GuardrailCustomWord.Builder builder()

    • serializableBuilderClass

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