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

Class ToxicLabels

java.lang.Object

software.amazon.awssdk.services.comprehend.model.ToxicLabels

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<ToxicLabels.Builder,ToxicLabels>

@Generated("software.amazon.awssdk:codegen")
public final class ToxicLabels
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<ToxicLabels.Builder,ToxicLabels>

Toxicity 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	ToxicLabels.Builder

Method Summary

Modifier and Type	Method	Description
static ToxicLabels.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasLabels()	For responses, this returns true if the service returned a value for the Labels property.
List<ToxicContent>	labels()	Array of toxic content types identified in the string.
List<SdkField<?>>	sdkFields()
static Class<? extends ToxicLabels.Builder>	serializableBuilderClass()
ToxicLabels.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
Float	toxicity()	Overall toxicity score for the string.

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

hasLabels

public final boolean hasLabels()

For responses, this returns true if the service returned a value for the Labels property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

labels

public final List<ToxicContent> labels()

Array of toxic content types identified in the string.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasLabels() method.

Returns:

Array of toxic content types identified in the string.

toxicity

public final Float toxicity()

Overall toxicity score for the string. Value range is zero to one, where one is the highest confidence.

Returns:

Overall toxicity score for the string. Value range is zero to one, where one is the highest confidence.

toBuilder

public ToxicLabels.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ToxicLabels.Builder,ToxicLabels>

builder

public static ToxicLabels.Builder builder()

serializableBuilderClass

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