Class: PlatformAPI::Pipeline

Inherits:
Object
  • Object
show all
Defined in:
lib/platform-api/client.rb

Overview

A pipeline allows grouping of apps into different stages.

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ Pipeline

Returns a new instance of Pipeline.



2652
2653
2654
 
# File 'lib/platform-api/client.rb', line 2652

def initialize(client)
  @client = client
end

Instance Method Details

#create(body = {}) ⇒ Object

Create a new pipeline.

Parameters:

  • body: —

    the object to pass as the request payload



2659
2660
2661
 
# File 'lib/platform-api/client.rb', line 2659

def create(body = {})
  @client.pipeline.create(body)
end

#delete(pipeline_id) ⇒ Object

Delete an existing pipeline.

Parameters:

  • pipeline_id: —

    unique identifier of pipeline



2673
2674
2675
 
# File 'lib/platform-api/client.rb', line 2673

def delete(pipeline_id)
  @client.pipeline.delete(pipeline_id)
end

#info(pipeline_id_or_pipeline_name) ⇒ Object

Info for existing pipeline.

Parameters:

  • pipeline_id_or_pipeline_name: —

    unique identifier of pipeline or name of pipeline



2666
2667
2668
 
# File 'lib/platform-api/client.rb', line 2666

def info(pipeline_id_or_pipeline_name)
  @client.pipeline.info(pipeline_id_or_pipeline_name)
end

#list ⇒ Object

List existing pipelines.



2686
2687
2688
 
# File 'lib/platform-api/client.rb', line 2686

def list()
  @client.pipeline.list()
end

#update(pipeline_id, body = {}) ⇒ Object

Update an existing pipeline.

Parameters:

  • pipeline_id: —

    unique identifier of pipeline

  • body: —

    the object to pass as the request payload



2681
2682
2683
 
# File 'lib/platform-api/client.rb', line 2681

def update(pipeline_id, body = {})
  @client.pipeline.update(pipeline_id, body)
end