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

Class TargetedSentimentEntity

java.lang.Object

software.amazon.awssdk.services.comprehend.model.TargetedSentimentEntity

All Implemented Interfaces:

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

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

Information about one of the entities found by targeted sentiment analysis.

For more information about targeted sentiment, see Targeted sentiment in the Amazon Comprehend Developer Guide.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	TargetedSentimentEntity.Builder

Method Summary

Modifier and Type	Method	Description
static TargetedSentimentEntity.Builder	builder()
List<Integer>	descriptiveMentionIndex()	One or more index into the Mentions array that provides the best name for the entity group.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasDescriptiveMentionIndex()	For responses, this returns true if the service returned a value for the DescriptiveMentionIndex property.
int	hashCode()
boolean	hasMentions()	For responses, this returns true if the service returned a value for the Mentions property.
List<TargetedSentimentMention>	mentions()	An array of mentions of the entity in the document.
List<SdkField<?>>	sdkFields()
static Class<? extends TargetedSentimentEntity.Builder>	serializableBuilderClass()
TargetedSentimentEntity.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

hasDescriptiveMentionIndex

public final boolean hasDescriptiveMentionIndex()

For responses, this returns true if the service returned a value for the DescriptiveMentionIndex 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.

descriptiveMentionIndex

public final List<Integer> descriptiveMentionIndex()

One or more index into the Mentions array that provides the best name for the entity group.

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 hasDescriptiveMentionIndex() method.

Returns:

One or more index into the Mentions array that provides the best name for the entity group.

hasMentions

public final boolean hasMentions()

For responses, this returns true if the service returned a value for the Mentions 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.

mentions

public final List<TargetedSentimentMention> mentions()

An array of mentions of the entity in the document. The array represents a co-reference group. See Co-reference group for an example.

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 hasMentions() method.

Returns:

An array of mentions of the entity in the document. The array represents a co-reference group. See Co-reference group for an example.

toBuilder

public TargetedSentimentEntity.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<TargetedSentimentEntity.Builder,TargetedSentimentEntity>

builder

public static TargetedSentimentEntity.Builder builder()

serializableBuilderClass

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