com.amazonaws.services.comprehend.model

Class ClassifyDocumentRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.comprehend.model.ClassifyDocumentRequest

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class ClassifyDocumentRequest
extends AmazonWebServiceRequest
implements java.io.Serializable

Creates a new document classification request to analyze a single document in real-time, using a previously created and trained custom model and an endpoint.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ClassifyDocumentRequest()

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.lang.String	getEndpointArn() The Amazon Resource Number (ARN) of the endpoint.
java.lang.String	getText() The document text to be analyzed.
int	hashCode()
void	setEndpointArn(java.lang.String endpointArn) The Amazon Resource Number (ARN) of the endpoint.
void	setText(java.lang.String text) The document text to be analyzed.
java.lang.String	toString() Returns a string representation of this object; useful for testing and debugging.
ClassifyDocumentRequest	withEndpointArn(java.lang.String endpointArn) The Amazon Resource Number (ARN) of the endpoint.
ClassifyDocumentRequest	withText(java.lang.String text) The document text to be analyzed.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

clone, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ClassifyDocumentRequest

public ClassifyDocumentRequest()

Method Detail

getText

public java.lang.String getText()

The document text to be analyzed.

Constraints:
Length: 1 -

Returns:

The document text to be analyzed.

setText

public void setText(java.lang.String text)

The document text to be analyzed.

Constraints:
Length: 1 -

Parameters:

text -

The document text to be analyzed.

withText

public ClassifyDocumentRequest withText(java.lang.String text)

The document text to be analyzed.

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

Constraints:
Length: 1 -

Parameters:

text -

The document text to be analyzed.

Returns:

A reference to this updated object so that method calls can be chained together.

getEndpointArn

public java.lang.String getEndpointArn()

The Amazon Resource Number (ARN) of the endpoint.

Constraints:
Length: - 256
Pattern: arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:document -classifier-endpoint/[a-zA-Z0-9](-*[a-zA-Z0-9])*

Returns:

The Amazon Resource Number (ARN) of the endpoint.

setEndpointArn

public void setEndpointArn(java.lang.String endpointArn)

The Amazon Resource Number (ARN) of the endpoint.

Constraints:
Length: - 256
Pattern: arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:document -classifier-endpoint/[a-zA-Z0-9](-*[a-zA-Z0-9])*

Parameters:

endpointArn -

The Amazon Resource Number (ARN) of the endpoint.

withEndpointArn

public ClassifyDocumentRequest withEndpointArn(java.lang.String endpointArn)

The Amazon Resource Number (ARN) of the endpoint.

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

Constraints:
Length: - 256
Pattern: arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:document -classifier-endpoint/[a-zA-Z0-9](-*[a-zA-Z0-9])*

Parameters:

endpointArn -

The Amazon Resource Number (ARN) of the endpoint.

Returns:

A reference to this updated object so that method calls can be chained together.

toString

public java.lang.String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object