software.amazon.awssdk.services.comprehend.model

Class BatchDetectKeyPhrasesResponse

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.BatchDetectKeyPhrasesResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<BatchDetectKeyPhrasesResponse.Builder,BatchDetectKeyPhrasesResponse>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	BatchDetectKeyPhrasesResponse.Builder

Method Summary

Modifier and Type	Method and Description
static BatchDetectKeyPhrasesResponse.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
List<BatchItemError>	errorList() A list containing one object for each document that contained an error.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasErrorList() For responses, this returns true if the service returned a value for the ErrorList property.
int	hashCode()
boolean	hasResultList() For responses, this returns true if the service returned a value for the ResultList property.
List<BatchDetectKeyPhrasesItemResult>	resultList() A list of objects containing the results of the operation.
List<SdkField<?>>	sdkFields()
static Class<? extends BatchDetectKeyPhrasesResponse.Builder>	serializableBuilderClass()
BatchDetectKeyPhrasesResponse.Builder	toBuilder()
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

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

hasResultList

public final boolean hasResultList()

For responses, this returns true if the service returned a value for the ResultList property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() 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.

resultList

public final List<BatchDetectKeyPhrasesItemResult> 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.

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 hasResultList() method.

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

For responses, this returns true if the service returned a value for the ErrorList property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() 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.

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.

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 hasErrorList() method.

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 BatchDetectKeyPhrasesResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<BatchDetectKeyPhrasesResponse.Builder,BatchDetectKeyPhrasesResponse>

Overrides:

toBuilder in class AwsResponse

builder

public static BatchDetectKeyPhrasesResponse.Builder builder()

serializableBuilderClass

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

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)

Overrides:

getValueForField in class SdkResponse

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo