com.amazonaws.services.translate.model

Class StopTextTranslationJobRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.translate.model.StopTextTranslationJobRequest

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class StopTextTranslationJobRequest
extends AmazonWebServiceRequest
implements java.io.Serializable

Stops an asynchronous batch translation job that is in progress.

If the job's state is IN_PROGRESS, the job will be 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 put into the STOPPED state.

Asynchronous batch translation jobs are started with the StartTextTranslationJob operation. You can use the DescribeTextTranslationJob or ListTextTranslationJobs operations to get a batch translation job's JobId.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
StopTextTranslationJobRequest()

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.lang.String	getJobId() The job ID of the job to be stopped.
int	hashCode()
void	setJobId(java.lang.String jobId) The job ID of the job to be stopped.
java.lang.String	toString() Returns a string representation of this object; useful for testing and debugging.
StopTextTranslationJobRequest	withJobId(java.lang.String jobId) The job ID of the job to be stopped.

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

StopTextTranslationJobRequest

public StopTextTranslationJobRequest()

Method Detail

getJobId

public java.lang.String getJobId()

The job ID of the job to be stopped.

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

Returns:

The job ID of the job to be stopped.

setJobId

public void setJobId(java.lang.String jobId)

The job ID of the job to be stopped.

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

Parameters:

jobId -

The job ID of the job to be stopped.

withJobId

public StopTextTranslationJobRequest withJobId(java.lang.String jobId)

The job ID of the job to be stopped.

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 job ID of the job to be stopped.

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