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.


2135
2136
2137
# File 'lib/platform-api/client.rb', line 2135

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


2142
2143
2144
# File 'lib/platform-api/client.rb', line 2142

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

#delete(pipeline_id) ⇒ Object

Delete an existing pipeline.

Parameters:

  • pipeline_id:

    unique identifier of pipeline


2156
2157
2158
# File 'lib/platform-api/client.rb', line 2156

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


2149
2150
2151
# File 'lib/platform-api/client.rb', line 2149

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

#listObject

List existing pipelines.


2169
2170
2171
# File 'lib/platform-api/client.rb', line 2169

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


2164
2165
2166
# File 'lib/platform-api/client.rb', line 2164

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