Class TargetedSentimentEntity
- All Implemented Interfaces:
Serializable
,SdkPojo
,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:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
One or more index into the Mentions array that provides the best name for the entity group.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final boolean
For responses, this returns true if the service returned a value for the DescriptiveMentionIndex property.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the Mentions property.final List
<TargetedSentimentMention> mentions()
An array of mentions of the entity in the document.static Class
<? extends TargetedSentimentEntity.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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 theisEmpty()
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
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 theisEmpty()
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
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
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 interfaceToCopyableBuilder<TargetedSentimentEntity.Builder,
TargetedSentimentEntity> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-