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.



1833
1834
1835
 
# File 'lib/platform-api/client.rb', line 1833

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



1840
1841
1842
 
# File 'lib/platform-api/client.rb', line 1840

def create(body)
  @client.pipeline.create(body)
end

#delete(pipeline_id) ⇒ Object

Delete an existing pipeline.

Parameters:

  • pipeline_id: —

    unique identifier of pipeline



1854
1855
1856
 
# File 'lib/platform-api/client.rb', line 1854

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



1847
1848
1849
 
# File 'lib/platform-api/client.rb', line 1847

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

#list ⇒ Object

List existing pipelines.



1867
1868
1869
 
# File 'lib/platform-api/client.rb', line 1867

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



1862
1863
1864
 
# File 'lib/platform-api/client.rb', line 1862

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