software.amazon.awssdk.services.comprehend.model

Class DetectEntitiesRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.comprehend.model.ComprehendRequest

software.amazon.awssdk.services.comprehend.model.DetectEntitiesRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DetectEntitiesRequest.Builder,DetectEntitiesRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DetectEntitiesRequest.Builder

Method Summary

Modifier and Type	Method and Description
static DetectEntitiesRequest.Builder	builder()
String	endpointArn() The Amazon Resource Name of an endpoint that is associated with a custom entity recognition model.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
LanguageCode	languageCode() The language of the input documents.
String	languageCodeAsString() The language of the input documents.
List<SdkField<?>>	sdkFields()
static Class<? extends DetectEntitiesRequest.Builder>	serializableBuilderClass()
String	text() A UTF-8 text string.
DetectEntitiesRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

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

text

public final String text()

A UTF-8 text string. Each string must contain fewer that 5,000 bytes of UTF-8 encoded characters.

Returns:

A UTF-8 text string. Each string must contain fewer that 5,000 bytes of UTF-8 encoded characters.

languageCode

public final LanguageCode languageCode()

The language of the input documents. You can specify any of the primary languages supported by Amazon Comprehend. All documents must be in the same language.

If your request includes the endpoint for a custom entity recognition model, Amazon Comprehend uses the language of your custom model, and it ignores any language code that you specify here.

If the service returns an enum value that is not available in the current SDK version, languageCode will return LanguageCode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from languageCodeAsString().

Returns:

The language of the input documents. You can specify any of the primary languages supported by Amazon Comprehend. All documents must be in the same language.

If your request includes the endpoint for a custom entity recognition model, Amazon Comprehend uses the language of your custom model, and it ignores any language code that you specify here.

See Also:

LanguageCode

languageCodeAsString

public final String languageCodeAsString()

The language of the input documents. You can specify any of the primary languages supported by Amazon Comprehend. All documents must be in the same language.

If your request includes the endpoint for a custom entity recognition model, Amazon Comprehend uses the language of your custom model, and it ignores any language code that you specify here.

If the service returns an enum value that is not available in the current SDK version, languageCode will return LanguageCode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from languageCodeAsString().

Returns:

The language of the input documents. You can specify any of the primary languages supported by Amazon Comprehend. All documents must be in the same language.

If your request includes the endpoint for a custom entity recognition model, Amazon Comprehend uses the language of your custom model, and it ignores any language code that you specify here.

See Also:

LanguageCode

endpointArn

public final String endpointArn()

The Amazon Resource Name of an endpoint that is associated with a custom entity recognition model. Provide an endpoint if you want to detect entities by using your own custom model instead of the default model that is used by Amazon Comprehend.

If you specify an endpoint, Amazon Comprehend uses the language of your custom model, and it ignores any language code that you provide in your request.

Returns:

The Amazon Resource Name of an endpoint that is associated with a custom entity recognition model. Provide an endpoint if you want to detect entities by using your own custom model instead of the default model that is used by Amazon Comprehend.

If you specify an endpoint, Amazon Comprehend uses the language of your custom model, and it ignores any language code that you provide in your request.

toBuilder

public DetectEntitiesRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DetectEntitiesRequest.Builder,DetectEntitiesRequest>

Specified by:

toBuilder in class ComprehendRequest

builder

public static DetectEntitiesRequest.Builder builder()

serializableBuilderClass

public static Class<? extends DetectEntitiesRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

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 SdkRequest

sdkFields

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

Specified by:

sdkFields in interface SdkPojo