software.amazon.awssdk.services.comprehend.model

Class BatchDetectSentimentItemResult

java.lang.Object

software.amazon.awssdk.services.comprehend.model.BatchDetectSentimentItemResult

All Implemented Interfaces:

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

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

The result of calling the operation. The operation returns one object for each document that is successfully processed by the operation.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	BatchDetectSentimentItemResult.Builder

Method Summary

Modifier and Type	Method and Description
static BatchDetectSentimentItemResult.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Integer	index() The zero-based index of the document in the input list.
List<SdkField<?>>	sdkFields()
SentimentType	sentiment() The sentiment detected in the document.
String	sentimentAsString() The sentiment detected in the document.
SentimentScore	sentimentScore() The level of confidence that Amazon Comprehend has in the accuracy of its sentiment detection.
static Class<? extends BatchDetectSentimentItemResult.Builder>	serializableBuilderClass()
BatchDetectSentimentItemResult.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

index

public final Integer index()

The zero-based index of the document in the input list.

Returns:

The zero-based index of the document in the input list.

sentiment

public final SentimentType sentiment()

The sentiment detected in the document.

If the service returns an enum value that is not available in the current SDK version, sentiment will return SentimentType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from sentimentAsString().

Returns:

The sentiment detected in the document.

See Also:

SentimentType

sentimentAsString

public final String sentimentAsString()

The sentiment detected in the document.

If the service returns an enum value that is not available in the current SDK version, sentiment will return SentimentType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from sentimentAsString().

Returns:

The sentiment detected in the document.

See Also:

SentimentType

sentimentScore

public final SentimentScore sentimentScore()

The level of confidence that Amazon Comprehend has in the accuracy of its sentiment detection.

Returns:

The level of confidence that Amazon Comprehend has in the accuracy of its sentiment detection.

toBuilder

public BatchDetectSentimentItemResult.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<BatchDetectSentimentItemResult.Builder,BatchDetectSentimentItemResult>

builder

public static BatchDetectSentimentItemResult.Builder builder()

serializableBuilderClass

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