com.amazonaws.services.comprehend.model

Class BatchDetectKeyPhrasesItemResult

java.lang.Object

com.amazonaws.services.comprehend.model.BatchDetectKeyPhrasesItemResult

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class BatchDetectKeyPhrasesItemResult
extends Object
implements Serializable, Cloneable, StructuredPojo

The result of calling the operation. The operation returns one object for each document that is successfully processed by the operation.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
BatchDetectKeyPhrasesItemResult()

Method Summary

Modifier and Type	Method and Description
BatchDetectKeyPhrasesItemResult	clone()
boolean	equals(Object obj)
Integer	getIndex() The zero-based index of the document in the input list.
List<KeyPhrase>	getKeyPhrases() One or more KeyPhrase objects, one for each key phrase detected in the document.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setIndex(Integer index) The zero-based index of the document in the input list.
void	setKeyPhrases(Collection<KeyPhrase> keyPhrases) One or more KeyPhrase objects, one for each key phrase detected in the document.
String	toString() Returns a string representation of this object.
BatchDetectKeyPhrasesItemResult	withIndex(Integer index) The zero-based index of the document in the input list.
BatchDetectKeyPhrasesItemResult	withKeyPhrases(Collection<KeyPhrase> keyPhrases) One or more KeyPhrase objects, one for each key phrase detected in the document.
BatchDetectKeyPhrasesItemResult	withKeyPhrases(KeyPhrase... keyPhrases) One or more KeyPhrase objects, one for each key phrase detected in the document.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

BatchDetectKeyPhrasesItemResult

public BatchDetectKeyPhrasesItemResult()

Method Detail

setIndex

public void setIndex(Integer index)

The zero-based index of the document in the input list.

Parameters:

index - The zero-based index of the document in the input list.

getIndex

public Integer getIndex()

The zero-based index of the document in the input list.

Returns:

The zero-based index of the document in the input list.

withIndex

public BatchDetectKeyPhrasesItemResult withIndex(Integer index)

The zero-based index of the document in the input list.

Parameters:

index - The zero-based index of the document in the input list.

Returns:

Returns a reference to this object so that method calls can be chained together.

getKeyPhrases

public List<KeyPhrase> getKeyPhrases()

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

Returns:

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

setKeyPhrases

public void setKeyPhrases(Collection<KeyPhrase> keyPhrases)

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

Parameters:

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

withKeyPhrases

public BatchDetectKeyPhrasesItemResult withKeyPhrases(KeyPhrase... keyPhrases)

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

NOTE: This method appends the values to the existing list (if any). Use setKeyPhrases(java.util.Collection) or withKeyPhrases(java.util.Collection) if you want to override the existing values.

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

withKeyPhrases

public BatchDetectKeyPhrasesItemResult withKeyPhrases(Collection<KeyPhrase> keyPhrases)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public BatchDetectKeyPhrasesItemResult clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.