Package software.amazon.awssdk.services.comprehend.model

Class ToxicContent

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

Toxic content analysis result for one string. For more information about toxicity detection, see Toxicity detection in the Amazon Comprehend Developer Guide

See Also:

  • Method Details

    • name

      public final ToxicContentType name()

      The name of the toxic content type.

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

      Returns:
      The name of the toxic content type.
      See Also:

    • nameAsString

      public final String nameAsString()

      The name of the toxic content type.

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

      Returns:
      The name of the toxic content type.
      See Also:

    • score

      public final Float score()

      Model confidence in the detected content type. Value range is zero to one, where one is highest confidence.

      Returns:
      Model confidence in the detected content type. Value range is zero to one, where one is highest confidence.

    • toBuilder

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

    • builder

      public static ToxicContent.Builder builder()

    • serializableBuilderClass

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