Class: PlatformAPI::PipelineCoupling

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

Overview

Information about an app's coupling to a pipeline

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ PipelineCoupling

Returns a new instance of PipelineCoupling.



2243
2244
2245
 
# File 'lib/platform-api/client.rb', line 2243

def initialize(client)
  @client = client
end

Instance Method Details

#create(body = {}) ⇒ Object

Create a new pipeline coupling.

Parameters:

  • body: —

    the object to pass as the request payload



2262
2263
2264
 
# File 'lib/platform-api/client.rb', line 2262

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

#delete(pipeline_coupling_id) ⇒ Object

Delete an existing pipeline coupling.

Parameters:

  • pipeline_coupling_id: —

    unique identifier of pipeline coupling



2276
2277
2278
 
# File 'lib/platform-api/client.rb', line 2276

def delete(pipeline_coupling_id)
  @client.pipeline_coupling.delete(pipeline_coupling_id)
end

#info(pipeline_coupling_id) ⇒ Object

Info for an existing pipeline coupling.

Parameters:

  • pipeline_coupling_id: —

    unique identifier of pipeline coupling



2269
2270
2271
 
# File 'lib/platform-api/client.rb', line 2269

def info(pipeline_coupling_id)
  @client.pipeline_coupling.info(pipeline_coupling_id)
end

#info_by_app(app_id_or_app_name) ⇒ Object

Info for an existing app pipeline coupling.

Parameters:

  • app_id_or_app_name: —

    unique identifier of app or unique name of app



2291
2292
2293
 
# File 'lib/platform-api/client.rb', line 2291

def info_by_app(app_id_or_app_name)
  @client.pipeline_coupling.info_by_app(app_id_or_app_name)
end

#list ⇒ Object

List pipeline couplings.



2255
2256
2257
 
# File 'lib/platform-api/client.rb', line 2255

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

#list_by_pipeline(pipeline_id) ⇒ Object

List couplings for a pipeline

Parameters:

  • pipeline_id: —

    unique identifier of pipeline



2250
2251
2252
 
# File 'lib/platform-api/client.rb', line 2250

def list_by_pipeline(pipeline_id)
  @client.pipeline_coupling.list_by_pipeline(pipeline_id)
end

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

Update an existing pipeline coupling.

Parameters:

  • pipeline_coupling_id: —

    unique identifier of pipeline coupling

  • body: —

    the object to pass as the request payload



2284
2285
2286
 
# File 'lib/platform-api/client.rb', line 2284

def update(pipeline_coupling_id, body = {})
  @client.pipeline_coupling.update(pipeline_coupling_id, body)
end