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.



2494
2495
2496
 
# File 'lib/platform-api/client.rb', line 2494

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



2525
2526
2527
 
# File 'lib/platform-api/client.rb', line 2525

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



2539
2540
2541
 
# File 'lib/platform-api/client.rb', line 2539

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



2532
2533
2534
 
# File 'lib/platform-api/client.rb', line 2532

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 pipeline coupling.

Parameters:

  • app_id_or_app_name: —

    unique identifier of app or unique name of app



2554
2555
2556
 
# File 'lib/platform-api/client.rb', line 2554

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.



2511
2512
2513
 
# File 'lib/platform-api/client.rb', line 2511

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

#list_by_current_user ⇒ Object

List pipeline couplings for the current user.



2506
2507
2508
 
# File 'lib/platform-api/client.rb', line 2506

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

#list_by_pipeline(pipeline_id) ⇒ Object

List couplings for a pipeline

Parameters:

  • pipeline_id: —

    unique identifier of pipeline



2501
2502
2503
 
# File 'lib/platform-api/client.rb', line 2501

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

#list_by_team(team_name_or_team_id) ⇒ Object

List pipeline couplings for a team.

Parameters:

  • team_name_or_team_id: —

    unique name of team or unique identifier of team



2518
2519
2520
 
# File 'lib/platform-api/client.rb', line 2518

def list_by_team(team_name_or_team_id)
  @client.pipeline_coupling.list_by_team(team_name_or_team_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



2547
2548
2549
 
# File 'lib/platform-api/client.rb', line 2547

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