software.amazon.awssdk.services.comprehend.model

Class BatchDetectSentimentItemResult

java.lang.Object

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

All Implemented Interfaces:

StructuredPojo, ToCopyableBuilder<BatchDetectSentimentItemResult.Builder,BatchDetectSentimentItemResult>

@Generated(value="software.amazon.awssdk:codegen")
public final class BatchDetectSentimentItemResult
extends Object
implements StructuredPojo, 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.

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)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Integer	index() The zero-based index of the document in the input list.
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
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() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

index

public 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 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 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 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()

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 interface ToCopyableBuilder<BatchDetectSentimentItemResult.Builder,BatchDetectSentimentItemResult>

Returns:

a builder for type T

builder

public static BatchDetectSentimentItemResult.Builder builder()

serializableBuilderClass

public static Class<? extends BatchDetectSentimentItemResult.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.