com.amazonaws.services.comprehend.model

Class StopKeyPhrasesDetectionJobRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.comprehend.model.StopKeyPhrasesDetectionJobRequest

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class StopKeyPhrasesDetectionJobRequest
extends AmazonWebServiceRequest
implements java.io.Serializable

Stops a key phrases detection job in progress.

If the job state is IN_PROGRESS the job is marked for termination and put into the STOP_REQUESTED state. If the job completes before it can be stopped, it is put into the COMPLETED state; otherwise the job is stopped and put into the STOPPED state.

If the job is in the COMPLETED or FAILED state when you call the StopDominantLanguageDetectionJob operation, the operation returns a 400 Internal Request Exception.

When a job is stopped, any documents already processed are written to the output location.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
StopKeyPhrasesDetectionJobRequest()

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.lang.String	getJobId() The identifier of the key phrases detection job to stop.
int	hashCode()
void	setJobId(java.lang.String jobId) The identifier of the key phrases detection job to stop.
java.lang.String	toString() Returns a string representation of this object; useful for testing and debugging.
StopKeyPhrasesDetectionJobRequest	withJobId(java.lang.String jobId) The identifier of the key phrases detection job to stop.

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

StopKeyPhrasesDetectionJobRequest

public StopKeyPhrasesDetectionJobRequest()

Method Detail

getJobId

public java.lang.String getJobId()

The identifier of the key phrases detection job to stop.

Constraints:
Length: 1 - 32
Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$

Returns:

The identifier of the key phrases detection job to stop.

setJobId

public void setJobId(java.lang.String jobId)

The identifier of the key phrases detection job to stop.

Constraints:
Length: 1 - 32
Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$

Parameters:

jobId -

The identifier of the key phrases detection job to stop.

withJobId

public StopKeyPhrasesDetectionJobRequest withJobId(java.lang.String jobId)

The identifier of the key phrases detection job to stop.

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

Constraints:
Length: 1 - 32
Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$

Parameters:

jobId -

The identifier of the key phrases detection job to stop.

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