Contents

module KineticSdk
  class Task

    # Delete a Run.
    #
    # @param id the id of the run to delete
    # @param headers [Hash] hash of headers to send, default is basic authentication
    # @return [KineticSdk::Utils::KineticHttpResponse] object, with +code+, +message+, +content_string+, and +content+ properties
    #
    # Example
    #
    #     delete_run(24548)
    #
    def delete_run(id, headers=header_basic_auth)
      @logger.info("Deleting run \"#{id}\"")
      delete("#{@api_url}/runs/#{id}", headers)
    end

    # Find runs.
    #
    # @param params [Hash] Query parameters that are added to the URL, such as +include+
    # @param headers [Hash] hash of headers to send, default is basic authentication
    # @return [KineticSdk::Utils::KineticHttpResponse] object, with +code+, +message+, +content_string+, and +content+ properties
    #
    # Example
    #
    #     find_runs({ "source" => "Kinetic Request CE" })
    #
    # Example
    # 
    #     find_runs({ "include" => "details" })
    #
    # Example
    #
    #     find_runs({ "source" => "Kinetic Request CE", "include" => "details" })
    #
    def find_runs(params={}, headers=header_basic_auth)
      @logger.info("Finding Runs")
      get("#{@api_url}/runs", params, headers)
    end

  end
end

Version data entries

37 entries across 37 versions & 1 rubygems

Version	Path
kinetic_sdk-5.0.29	lib/kinetic_sdk/task/lib/runs.rb
kinetic_sdk-5.0.28	lib/kinetic_sdk/task/lib/runs.rb
kinetic_sdk-5.0.27	lib/kinetic_sdk/task/lib/runs.rb
kinetic_sdk-5.0.26	lib/kinetic_sdk/task/lib/runs.rb
kinetic_sdk-5.0.25	lib/kinetic_sdk/task/lib/runs.rb
kinetic_sdk-5.0.24	lib/kinetic_sdk/task/lib/runs.rb
kinetic_sdk-5.0.23	lib/kinetic_sdk/task/lib/runs.rb
kinetic_sdk-5.0.22	lib/kinetic_sdk/task/lib/runs.rb
kinetic_sdk-5.0.21	lib/kinetic_sdk/task/lib/runs.rb
kinetic_sdk-5.0.20	lib/kinetic_sdk/task/lib/runs.rb
kinetic_sdk-5.0.19	lib/kinetic_sdk/task/lib/runs.rb
kinetic_sdk-5.0.18	lib/kinetic_sdk/task/lib/runs.rb
kinetic_sdk-5.0.17	lib/kinetic_sdk/task/lib/runs.rb
kinetic_sdk-5.0.16	lib/kinetic_sdk/task/lib/runs.rb
kinetic_sdk-5.0.15	lib/kinetic_sdk/task/lib/runs.rb
kinetic_sdk-5.0.14	lib/kinetic_sdk/task/lib/runs.rb
kinetic_sdk-5.0.13	lib/kinetic_sdk/task/lib/runs.rb
kinetic_sdk-5.0.12	lib/kinetic_sdk/task/lib/runs.rb
kinetic_sdk-5.0.11	lib/kinetic_sdk/task/lib/runs.rb
kinetic_sdk-5.0.10	lib/kinetic_sdk/task/lib/runs.rb