com.amazonaws.services.datapipeline.model

Class DeactivatePipelineRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.datapipeline.model.DeactivatePipelineRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class DeactivatePipelineRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Container for the parameters to the DeactivatePipeline operation.

Deactivates the specified running pipeline. The pipeline is set to the DEACTIVATING state until the deactivation process completes.

To resume a deactivated pipeline, use ActivatePipeline. By default, the pipeline resumes from the last completed execution. Optionally, you can specify the date and time to resume the pipeline.

See Also:

DataPipeline.deactivatePipeline(DeactivatePipelineRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
DeactivatePipelineRequest()

Method Summary

Methods

Modifier and Type	Method and Description
DeactivatePipelineRequest	clone() Creates a shallow clone of this request.
boolean	equals(Object obj)
Boolean	getCancelActive() Indicates whether to cancel any running objects.
String	getPipelineId() The ID of the pipeline.
int	hashCode()
Boolean	isCancelActive() Indicates whether to cancel any running objects.
void	setCancelActive(Boolean cancelActive) Indicates whether to cancel any running objects.
void	setPipelineId(String pipelineId) The ID of the pipeline.
String	toString() Returns a string representation of this object; useful for testing and debugging.
DeactivatePipelineRequest	withCancelActive(Boolean cancelActive) Indicates whether to cancel any running objects.
DeactivatePipelineRequest	withPipelineId(String pipelineId) The ID of the pipeline.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyBaseTo, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

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

Constructor Detail

DeactivatePipelineRequest

public DeactivatePipelineRequest()

Method Detail

getPipelineId

public String getPipelineId()

The ID of the pipeline.

Constraints:
Length: 1 - 1024
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Returns:

The ID of the pipeline.

setPipelineId

public void setPipelineId(String pipelineId)

The ID of the pipeline.

Constraints:
Length: 1 - 1024
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Parameters:

pipelineId - The ID of the pipeline.

withPipelineId

public DeactivatePipelineRequest withPipelineId(String pipelineId)

The ID of the pipeline.

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

Constraints:
Length: 1 - 1024
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Parameters:

pipelineId - The ID of the pipeline.

Returns:

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

isCancelActive

public Boolean isCancelActive()

Indicates whether to cancel any running objects. The default is true, which sets the state of any running objects to CANCELED. If this value is false, the pipeline is deactivated after all running objects finish.

Returns:

Indicates whether to cancel any running objects. The default is true, which sets the state of any running objects to CANCELED. If this value is false, the pipeline is deactivated after all running objects finish.

setCancelActive

public void setCancelActive(Boolean cancelActive)

Indicates whether to cancel any running objects. The default is true, which sets the state of any running objects to CANCELED. If this value is false, the pipeline is deactivated after all running objects finish.

Parameters:

cancelActive - Indicates whether to cancel any running objects. The default is true, which sets the state of any running objects to CANCELED. If this value is false, the pipeline is deactivated after all running objects finish.

withCancelActive

public DeactivatePipelineRequest withCancelActive(Boolean cancelActive)

Indicates whether to cancel any running objects. The default is true, which sets the state of any running objects to CANCELED. If this value is false, the pipeline is deactivated after all running objects finish.

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

Parameters:

cancelActive - Indicates whether to cancel any running objects. The default is true, which sets the state of any running objects to CANCELED. If this value is false, the pipeline is deactivated after all running objects finish.

Returns:

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

getCancelActive

public Boolean getCancelActive()

Indicates whether to cancel any running objects. The default is true, which sets the state of any running objects to CANCELED. If this value is false, the pipeline is deactivated after all running objects finish.

Returns:

Indicates whether to cancel any running objects. The default is true, which sets the state of any running objects to CANCELED. If this value is false, the pipeline is deactivated after all running objects finish.

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

clone

public DeactivatePipelineRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()