com.amazonaws.services.elastictranscoder.model
Class CancelJobRequest

java.lang.Object
  com.amazonaws.AmazonWebServiceRequest
      com.amazonaws.services.elastictranscoder.model.CancelJobRequest

All Implemented Interfaces:

Serializable

public class CancelJobRequest
extends AmazonWebServiceRequest
implements Serializable

Container for the parameters to the CancelJob operation.

The CancelJob operation cancels an unfinished job.

NOTE:You can only cancel a job that has a status of Submitted. To prevent a pipeline from starting to process a job while you're getting the job identifier, use UpdatePipelineStatus to temporarily pause the pipeline.

See Also:

AmazonElasticTranscoder.cancelJob(CancelJobRequest), Serialized Form

Constructor Summary

CancelJobRequest()

Method Summary

boolean	equals(Object obj)
String	getId() The identifier of the job that you want to cancel.
int	hashCode()
void	setId(String id) The identifier of the job that you want to cancel.
String	toString() Returns a string representation of this object; useful for testing and debugging.
CancelJobRequest	withId(String id) The identifier of the job that you want to cancel.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyPrivateRequestParameters, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setRequestCredentials, setRequestMetricCollector, withRequestMetricCollector

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CancelJobRequest

public CancelJobRequest()

Method Detail

getId

public String getId()

The identifier of the job that you want to cancel.

To get a list of the jobs (including their jobId) that have a status of Submitted, use the ListJobsByStatus API action.

Constraints:
Pattern: ^\d{13}-\w{6}$

Returns:

The identifier of the job that you want to cancel.

To get a list of the jobs (including their jobId) that have a status of Submitted, use the ListJobsByStatus API action.

setId

public void setId(String id)

The identifier of the job that you want to cancel.

To get a list of the jobs (including their jobId) that have a status of Submitted, use the ListJobsByStatus API action.

Constraints:
Pattern: ^\d{13}-\w{6}$

Parameters:

id - The identifier of the job that you want to cancel.

To get a list of the jobs (including their jobId) that have a status of Submitted, use the ListJobsByStatus API action.

withId

public CancelJobRequest withId(String id)

The identifier of the job that you want to cancel.

To get a list of the jobs (including their jobId) that have a status of Submitted, use the ListJobsByStatus API action.

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

Constraints:
Pattern: ^\d{13}-\w{6}$

Parameters:

id - The identifier of the job that you want to cancel.

To get a list of the jobs (including their jobId) that have a status of Submitted, use the ListJobsByStatus API action.

Returns:

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

toString

public String toString()

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

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object