software.amazon.awssdk.services.comprehend.model

Class BatchDetectKeyPhrasesItemResult

java.lang.Object

software.amazon.awssdk.services.comprehend.model.BatchDetectKeyPhrasesItemResult

All Implemented Interfaces:

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

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

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	BatchDetectKeyPhrasesItemResult.Builder

Method Summary

Modifier and Type	Method and Description
static BatchDetectKeyPhrasesItemResult.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasKeyPhrases() For responses, this returns true if the service returned a value for the KeyPhrases property.
Integer	index() The zero-based index of the document in the input list.
List<KeyPhrase>	keyPhrases() One or more KeyPhrase objects, one for each key phrase detected in the document.
List<SdkField<?>>	sdkFields()
static Class<? extends BatchDetectKeyPhrasesItemResult.Builder>	serializableBuilderClass()
BatchDetectKeyPhrasesItemResult.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.

hasKeyPhrases

public final boolean hasKeyPhrases()

For responses, this returns true if the service returned a value for the KeyPhrases 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.

keyPhrases

public final List<KeyPhrase> keyPhrases()

One or more KeyPhrase objects, one for each key phrase detected in the document.

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

Returns:

One or more KeyPhrase objects, one for each key phrase detected in the document.

toBuilder

public BatchDetectKeyPhrasesItemResult.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<BatchDetectKeyPhrasesItemResult.Builder,BatchDetectKeyPhrasesItemResult>

builder

public static BatchDetectKeyPhrasesItemResult.Builder builder()

serializableBuilderClass

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