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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ToxicContent.Builder

Method Summary

Modifier and Type	Method	Description
static ToxicContent.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
ToxicContentType	name()	The name of the toxic content type.
String	nameAsString()	The name of the toxic content type.
Float	score()	Model confidence in the detected content type.
List<SdkField<?>>	sdkFields()
static Class<? extends ToxicContent.Builder>	serializableBuilderClass()
ToxicContent.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

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:

ToxicContentType

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:

ToxicContentType

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()

Specified by:

toBuilder in interface ToCopyableBuilder<ToxicContent.Builder,ToxicContent>

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)

Specified by:

equalsBySdkFields in interface SdkPojo

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