com.amazonaws.services.comprehend.model

Class StopTrainingDocumentClassifierRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.comprehend.model.StopTrainingDocumentClassifierRequest

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class StopTrainingDocumentClassifierRequest
extends AmazonWebServiceRequest
implements java.io.Serializable

Stops a document classifier training job while in progress.

If the training job state is TRAINING, the job is marked for termination and put into the STOP_REQUESTED state. If the training job completes before it can be stopped, it is put into the TRAINED; otherwise the training job is stopped and put into the STOPPED state and the service sends back an HTTP 200 response with an empty HTTP body.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
StopTrainingDocumentClassifierRequest()

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.lang.String	getDocumentClassifierArn() The Amazon Resource Name (ARN) that identifies the document classifier currently being trained.
int	hashCode()
void	setDocumentClassifierArn(java.lang.String documentClassifierArn) The Amazon Resource Name (ARN) that identifies the document classifier currently being trained.
java.lang.String	toString() Returns a string representation of this object; useful for testing and debugging.
StopTrainingDocumentClassifierRequest	withDocumentClassifierArn(java.lang.String documentClassifierArn) The Amazon Resource Name (ARN) that identifies the document classifier currently being trained.

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

StopTrainingDocumentClassifierRequest

public StopTrainingDocumentClassifierRequest()

Method Detail

getDocumentClassifierArn

public java.lang.String getDocumentClassifierArn()

The Amazon Resource Name (ARN) that identifies the document classifier currently being trained.

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

Returns:

The Amazon Resource Name (ARN) that identifies the document classifier currently being trained.

setDocumentClassifierArn

public void setDocumentClassifierArn(java.lang.String documentClassifierArn)

The Amazon Resource Name (ARN) that identifies the document classifier currently being trained.

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

Parameters:

documentClassifierArn -

The Amazon Resource Name (ARN) that identifies the document classifier currently being trained.

withDocumentClassifierArn

public StopTrainingDocumentClassifierRequest withDocumentClassifierArn(java.lang.String documentClassifierArn)

The Amazon Resource Name (ARN) that identifies the document classifier currently being trained.

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/[a-zA-Z0-9](-*[a-zA-Z0-9])*

Parameters:

documentClassifierArn -

The Amazon Resource Name (ARN) that identifies the document classifier currently being trained.

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