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)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
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() 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.

keyPhrases

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

Returns:

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

toBuilder

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

Returns:

a builder for type T

builder

public static BatchDetectKeyPhrasesItemResult.Builder builder()

serializableBuilderClass

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

sdkFields

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