com.amazonaws.services.codepipeline.model

Class StopPipelineExecutionRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.codepipeline.model.StopPipelineExecutionRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class StopPipelineExecutionRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
StopPipelineExecutionRequest()

Method Summary

Modifier and Type	Method and Description
StopPipelineExecutionRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
Boolean	getAbandon() Use this option to stop the pipeline execution by abandoning, rather than finishing, in-progress actions.
String	getPipelineExecutionId() The ID of the pipeline execution to be stopped in the current stage.
String	getPipelineName() The name of the pipeline to stop.
String	getReason() Use this option to enter comments, such as the reason the pipeline was stopped.
int	hashCode()
Boolean	isAbandon() Use this option to stop the pipeline execution by abandoning, rather than finishing, in-progress actions.
void	setAbandon(Boolean abandon) Use this option to stop the pipeline execution by abandoning, rather than finishing, in-progress actions.
void	setPipelineExecutionId(String pipelineExecutionId) The ID of the pipeline execution to be stopped in the current stage.
void	setPipelineName(String pipelineName) The name of the pipeline to stop.
void	setReason(String reason) Use this option to enter comments, such as the reason the pipeline was stopped.
String	toString() Returns a string representation of this object.
StopPipelineExecutionRequest	withAbandon(Boolean abandon) Use this option to stop the pipeline execution by abandoning, rather than finishing, in-progress actions.
StopPipelineExecutionRequest	withPipelineExecutionId(String pipelineExecutionId) The ID of the pipeline execution to be stopped in the current stage.
StopPipelineExecutionRequest	withPipelineName(String pipelineName) The name of the pipeline to stop.
StopPipelineExecutionRequest	withReason(String reason) Use this option to enter comments, such as the reason the pipeline was stopped.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

StopPipelineExecutionRequest

public StopPipelineExecutionRequest()

Method Detail

setPipelineName

public void setPipelineName(String pipelineName)

The name of the pipeline to stop.

Parameters:

pipelineName - The name of the pipeline to stop.

getPipelineName

public String getPipelineName()

The name of the pipeline to stop.

Returns:

The name of the pipeline to stop.

withPipelineName

public StopPipelineExecutionRequest withPipelineName(String pipelineName)

The name of the pipeline to stop.

Parameters:

pipelineName - The name of the pipeline to stop.

Returns:

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

setPipelineExecutionId

public void setPipelineExecutionId(String pipelineExecutionId)

The ID of the pipeline execution to be stopped in the current stage. Use the GetPipelineState action to retrieve the current pipelineExecutionId.

Parameters:

pipelineExecutionId - The ID of the pipeline execution to be stopped in the current stage. Use the GetPipelineState action to retrieve the current pipelineExecutionId.

getPipelineExecutionId

public String getPipelineExecutionId()

The ID of the pipeline execution to be stopped in the current stage. Use the GetPipelineState action to retrieve the current pipelineExecutionId.

Returns:

The ID of the pipeline execution to be stopped in the current stage. Use the GetPipelineState action to retrieve the current pipelineExecutionId.

withPipelineExecutionId

public StopPipelineExecutionRequest withPipelineExecutionId(String pipelineExecutionId)

The ID of the pipeline execution to be stopped in the current stage. Use the GetPipelineState action to retrieve the current pipelineExecutionId.

Parameters:

pipelineExecutionId - The ID of the pipeline execution to be stopped in the current stage. Use the GetPipelineState action to retrieve the current pipelineExecutionId.

Returns:

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

setAbandon

public void setAbandon(Boolean abandon)

Use this option to stop the pipeline execution by abandoning, rather than finishing, in-progress actions.

This option can lead to failed or out-of-sequence tasks.

Parameters:

abandon - Use this option to stop the pipeline execution by abandoning, rather than finishing, in-progress actions.

This option can lead to failed or out-of-sequence tasks.

getAbandon

public Boolean getAbandon()

Use this option to stop the pipeline execution by abandoning, rather than finishing, in-progress actions.

This option can lead to failed or out-of-sequence tasks.

Returns:

Use this option to stop the pipeline execution by abandoning, rather than finishing, in-progress actions.

This option can lead to failed or out-of-sequence tasks.

withAbandon

public StopPipelineExecutionRequest withAbandon(Boolean abandon)

Use this option to stop the pipeline execution by abandoning, rather than finishing, in-progress actions.

This option can lead to failed or out-of-sequence tasks.

Parameters:

abandon - Use this option to stop the pipeline execution by abandoning, rather than finishing, in-progress actions.

This option can lead to failed or out-of-sequence tasks.

Returns:

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

isAbandon

public Boolean isAbandon()

Use this option to stop the pipeline execution by abandoning, rather than finishing, in-progress actions.

This option can lead to failed or out-of-sequence tasks.

Returns:

Use this option to stop the pipeline execution by abandoning, rather than finishing, in-progress actions.

This option can lead to failed or out-of-sequence tasks.

setReason

public void setReason(String reason)

Use this option to enter comments, such as the reason the pipeline was stopped.

Parameters:

reason - Use this option to enter comments, such as the reason the pipeline was stopped.

getReason

public String getReason()

Use this option to enter comments, such as the reason the pipeline was stopped.

Returns:

Use this option to enter comments, such as the reason the pipeline was stopped.

withReason

public StopPipelineExecutionRequest withReason(String reason)

Use this option to enter comments, such as the reason the pipeline was stopped.

Parameters:

reason - Use this option to enter comments, such as the reason the pipeline was stopped.

Returns:

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

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public StopPipelineExecutionRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()