Class GuardrailManagedWord

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

The managed word details for the filter in the Guardrail.

See Also:

  • Method Details

    • match

      public final String match()

      The match details for the managed word filter in the Guardrail.

      Returns:
      The match details for the managed word filter in the Guardrail.

    • type

      public final GuardrailManagedWordType type()

      The type details for the managed word filter in the Guardrail.

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

      Returns:
      The type details for the managed word filter in the Guardrail.
      See Also:

    • typeAsString

      public final String typeAsString()

      The type details for the managed word filter in the Guardrail.

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

      Returns:
      The type details for the managed word filter in the Guardrail.
      See Also:

    • action

      public final GuardrailWordPolicyAction action()

      The action details for the managed word filter in the Guardrail.

      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 details for the managed word filter in the Guardrail.
      See Also:

    • actionAsString

      public final String actionAsString()

      The action details for the managed word filter in the Guardrail.

      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 details for the managed word filter in the Guardrail.
      See Also:

    • toBuilder

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

    • builder

      public static GuardrailManagedWord.Builder builder()

    • serializableBuilderClass

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