public class CancelJobRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
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.
NOOP| Constructor and Description |
|---|
CancelJobRequest() |
| Modifier and Type | Method and Description |
|---|---|
CancelJobRequest |
clone()
Creates a shallow clone of this request.
|
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.
|
copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollectorpublic String getId()
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}$
To get a list of
the jobs (including their jobId) that have a status of
Submitted, use the ListJobsByStatus API action.
public void setId(String id)
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}$
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.
public CancelJobRequest withId(String id)
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}$
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.
public String toString()
toString in class ObjectObject.toString()public CancelJobRequest clone()
AmazonWebServiceRequestclone in class AmazonWebServiceRequestObject.clone()Copyright © 2015. All rights reserved.