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

Contains the parameters for DeactivatePipeline.

See Also:
  • Constructor Details

    • DeactivatePipelineRequest

      public DeactivatePipelineRequest()
  • Method Details

    • setPipelineId

      public void setPipelineId(String pipelineId)

      The ID of the pipeline.

      Parameters:
      pipelineId - The ID of the pipeline.
    • getPipelineId

      public String getPipelineId()

      The ID of the pipeline.

      Returns:
      The ID of the pipeline.
    • withPipelineId

      public DeactivatePipelineRequest withPipelineId(String pipelineId)

      The ID of the pipeline.

      Parameters:
      pipelineId - The ID of the pipeline.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • 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.
    • 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.
    • 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.

      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:
      Returns a reference to this 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.
    • 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:
    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object
    • hashCode

      public int hashCode()
      Overrides:
      hashCode 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: