Sha256: 452f4452956bcb34a26cf6f38d0aed740de570abccbaa470f613696f05dcc50a

Contents?: true

Size: 1.2 KB

Versions: 8

Compression:

Stored size: 1.2 KB

Contents

module Fog
  module AWS
    class DataPipeline
      class Real
        # Activate a pipeline
        # http://docs.aws.amazon.com/datapipeline/latest/APIReference/API_DectivatePipeline.html
        # ==== Parameters
        # * PipelineId <~String> - The ID of the pipeline to activate
        # ' cancelActive <~Boolean> - 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
        # * response<~Excon::Response>:
        #   * body<~Hash>:
        def deactivate_pipeline(id, cancel_active=true)
          params = { 'pipelineId' => id, 'cancelActive' => cancel_active }

          response = request({
            :body => Fog::JSON.encode(params),
            :headers => { 'X-Amz-Target' => 'DataPipeline.DeactivatePipeline' }
          })
        end
      end

      class Mock
        def deactivate_pipeline(id, cancel_active=true)
          response = Excon::Response.new

          pipeline = find_pipeline(id)
          pipeline[:active] = false

          response.body = {}
          response
        end
      end
    end
  end
end

Version data entries

8 entries across 8 versions & 1 rubygems

Version Path
fog-aws-3.30.0 lib/fog/aws/requests/data_pipeline/deactivate_pipeline.rb
fog-aws-3.29.0 lib/fog/aws/requests/data_pipeline/deactivate_pipeline.rb
fog-aws-3.28.0 lib/fog/aws/requests/data_pipeline/deactivate_pipeline.rb
fog-aws-3.27.0 lib/fog/aws/requests/data_pipeline/deactivate_pipeline.rb
fog-aws-3.26.0 lib/fog/aws/requests/data_pipeline/deactivate_pipeline.rb
fog-aws-3.25.0 lib/fog/aws/requests/data_pipeline/deactivate_pipeline.rb
fog-aws-3.24.0 lib/fog/aws/requests/data_pipeline/deactivate_pipeline.rb
fog-aws-3.23.0 lib/fog/aws/requests/data_pipeline/deactivate_pipeline.rb