com.amazonaws.services.comprehend.model

Class ToxicLabels

java.lang.Object

com.amazonaws.services.comprehend.model.ToxicLabels

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ToxicLabels
extends Object
implements Serializable, Cloneable, StructuredPojo

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

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
ToxicLabels()

Method Summary

Modifier and Type	Method and Description
ToxicLabels	clone()
boolean	equals(Object obj)
List<ToxicContent>	getLabels() Array of toxic content types identified in the string.
Float	getToxicity() Overall toxicity score for the string.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller)
void	setLabels(Collection<ToxicContent> labels) Array of toxic content types identified in the string.
void	setToxicity(Float toxicity) Overall toxicity score for the string.
String	toString() Returns a string representation of this object.
ToxicLabels	withLabels(Collection<ToxicContent> labels) Array of toxic content types identified in the string.
ToxicLabels	withLabels(ToxicContent... labels) Array of toxic content types identified in the string.
ToxicLabels	withToxicity(Float toxicity) Overall toxicity score for the string.

Methods inherited from class java.lang.Object

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

Constructor Detail

ToxicLabels

public ToxicLabels()

Method Detail

getLabels

public List<ToxicContent> getLabels()

Array of toxic content types identified in the string.

Returns:

Array of toxic content types identified in the string.

setLabels

public void setLabels(Collection<ToxicContent> labels)

Array of toxic content types identified in the string.

Parameters:

labels - Array of toxic content types identified in the string.

withLabels

public ToxicLabels withLabels(ToxicContent... labels)

Array of toxic content types identified in the string.

NOTE: This method appends the values to the existing list (if any). Use setLabels(java.util.Collection) or withLabels(java.util.Collection) if you want to override the existing values.

Parameters:

labels - Array of toxic content types identified in the string.

Returns:

Returns a reference to this object so that method calls can be chained together.

withLabels

public ToxicLabels withLabels(Collection<ToxicContent> labels)

Array of toxic content types identified in the string.

Parameters:

labels - Array of toxic content types identified in the string.

Returns:

Returns a reference to this object so that method calls can be chained together.

setToxicity

public void setToxicity(Float toxicity)

Overall toxicity score for the string.

Parameters:

toxicity - Overall toxicity score for the string.

getToxicity

public Float getToxicity()

Overall toxicity score for the string.

Returns:

Overall toxicity score for the string.

withToxicity

public ToxicLabels withToxicity(Float toxicity)

Overall toxicity score for the string.

Parameters:

toxicity - Overall toxicity score for the string.

Returns:

Returns a reference to this object so that method calls can be chained together.

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public ToxicLabels clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Specified by:

marshall in interface StructuredPojo