com.amazonaws.services.comprehend.model

Class DetectEntitiesRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.comprehend.model.DetectEntitiesRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

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

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
DetectEntitiesRequest()

Method Summary

Modifier and Type	Method and Description
DetectEntitiesRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getEndpointArn() The Amazon Resource Name of an endpoint that is associated with a custom entity recognition model.
String	getLanguageCode() The language of the input documents.
String	getText() A UTF-8 text string.
int	hashCode()
void	setEndpointArn(String endpointArn) The Amazon Resource Name of an endpoint that is associated with a custom entity recognition model.
void	setLanguageCode(String languageCode) The language of the input documents.
void	setText(String text) A UTF-8 text string.
String	toString() Returns a string representation of this object.
DetectEntitiesRequest	withEndpointArn(String endpointArn) The Amazon Resource Name of an endpoint that is associated with a custom entity recognition model.
DetectEntitiesRequest	withLanguageCode(LanguageCode languageCode) The language of the input documents.
DetectEntitiesRequest	withLanguageCode(String languageCode) The language of the input documents.
DetectEntitiesRequest	withText(String text) A UTF-8 text string.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DetectEntitiesRequest

public DetectEntitiesRequest()

Method Detail

setText

public void setText(String text)

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

Parameters:

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

getText

public String getText()

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.

withText

public DetectEntitiesRequest withText(String text)

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

Parameters:

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

Returns:

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

setLanguageCode

public void setLanguageCode(String 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.

Parameters:

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.

See Also:

LanguageCode

getLanguageCode

public String getLanguageCode()

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.

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

withLanguageCode

public DetectEntitiesRequest withLanguageCode(String 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.

Parameters:

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.

Returns:

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

See Also:

LanguageCode

withLanguageCode

public DetectEntitiesRequest withLanguageCode(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.

Parameters:

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.

Returns:

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

See Also:

LanguageCode

setEndpointArn

public void setEndpointArn(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.

Parameters:

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.

getEndpointArn

public String getEndpointArn()

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.

withEndpointArn

public DetectEntitiesRequest withEndpointArn(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.

Parameters:

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:

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

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()