software.amazon.awssdk.services.comprehend.model

Class DetectKeyPhrasesResponse

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DetectKeyPhrasesResponse.Builder,DetectKeyPhrasesResponse>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DetectKeyPhrasesResponse.Builder

Method Summary

Modifier and Type	Method and Description
static DetectKeyPhrasesResponse.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.
List<KeyPhrase>	keyPhrases() A collection of key phrases that Amazon Comprehend identified in the input text.
List<SdkField<?>>	sdkFields()
static Class<? extends DetectKeyPhrasesResponse.Builder>	serializableBuilderClass()
DetectKeyPhrasesResponse.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

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

A collection of key phrases that Amazon Comprehend identified in the input text. For each key phrase, the response provides the text of the key phrase, where the key phrase begins and ends, and the level of confidence that Amazon Comprehend has in the accuracy of the detection.

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:

A collection of key phrases that Amazon Comprehend identified in the input text. For each key phrase, the response provides the text of the key phrase, where the key phrase begins and ends, and the level of confidence that Amazon Comprehend has in the accuracy of the detection.

toBuilder

public DetectKeyPhrasesResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DetectKeyPhrasesResponse.Builder,DetectKeyPhrasesResponse>

Overrides:

toBuilder in class AwsResponse

builder

public static DetectKeyPhrasesResponse.Builder builder()

serializableBuilderClass

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