software.amazon.awssdk.services.comprehend.model

Class BatchDetectSentimentResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.comprehend.model.ComprehendResponse

software.amazon.awssdk.services.comprehend.model.BatchDetectSentimentResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<BatchDetectSentimentResponse.Builder,BatchDetectSentimentResponse>

@Generated(value="software.amazon.awssdk:codegen")
public final class BatchDetectSentimentResponse
extends ComprehendResponse
implements ToCopyableBuilder<BatchDetectSentimentResponse.Builder,BatchDetectSentimentResponse>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	BatchDetectSentimentResponse.Builder

Method Summary

Modifier and Type	Method and Description
static BatchDetectSentimentResponse.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.
List<BatchItemError>	errorList() A list containing one object for each document that contained an error.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkResponse.
boolean	hasErrorList() Returns true if the ErrorList property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
int	hashCode()
boolean	hasResultList() Returns true if the ResultList property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
List<BatchDetectSentimentItemResult>	resultList() A list of objects containing the results of the operation.
List<SdkField<?>>	sdkFields()
static Class<? extends BatchDetectSentimentResponse.Builder>	serializableBuilderClass()
BatchDetectSentimentResponse.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.services.comprehend.model.ComprehendResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

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

hasResultList

public final boolean hasResultList()

Returns true if the ResultList property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

resultList

public final List<BatchDetectSentimentItemResult> resultList()

A list of objects containing the results of the operation. The results are sorted in ascending order by the Index field and match the order of the documents in the input list. If all of the documents contain an error, the ResultList is empty.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasResultList() to see if a value was sent in this field.

Returns:

A list of objects containing the results of the operation. The results are sorted in ascending order by the Index field and match the order of the documents in the input list. If all of the documents contain an error, the ResultList is empty.

hasErrorList

public final boolean hasErrorList()

Returns true if the ErrorList property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

errorList

public final List<BatchItemError> errorList()

A list containing one object for each document that contained an error. The results are sorted in ascending order by the Index field and match the order of the documents in the input list. If there are no errors in the batch, the ErrorList is empty.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasErrorList() to see if a value was sent in this field.

Returns:

A list containing one object for each document that contained an error. The results are sorted in ascending order by the Index field and match the order of the documents in the input list. If there are no errors in the batch, the ErrorList is empty.

toBuilder

public BatchDetectSentimentResponse.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<BatchDetectSentimentResponse.Builder,BatchDetectSentimentResponse>

Specified by:

toBuilder in class AwsResponse

Returns:

a builder for type T

builder

public static BatchDetectSentimentResponse.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsResponse

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)

Description copied from class: SdkResponse

Used to retrieve the value of a field from any class that extends SdkResponse. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkResponse.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkResponse

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value

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.