Class BatchDetectSentimentItemResult

java.lang.Object
software.amazon.awssdk.services.comprehend.model.BatchDetectSentimentItemResult
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<BatchDetectSentimentItemResult.Builder,BatchDetectSentimentItemResult>
@Generated("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:

  • Method Details

    • 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:

    • 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:

    • 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()
      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 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)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.