class PlatformAPI::PipelineCoupling

Information about an app's coupling to a pipeline

Public Class Methods

new(client) click to toggle source
# File lib/platform-api/client.rb, line 2435
def initialize(client)
  @client = client
end

Public Instance Methods

create(body = {}) click to toggle source

Create a new pipeline coupling.

@param body: the object to pass as the request payload

# File lib/platform-api/client.rb, line 2466
def create(body = {})
  @client.pipeline_coupling.create(body)
end
delete(pipeline_coupling_id) click to toggle source

Delete an existing pipeline coupling.

@param pipeline_coupling_id: unique identifier of pipeline coupling

# File lib/platform-api/client.rb, line 2480
def delete(pipeline_coupling_id)
  @client.pipeline_coupling.delete(pipeline_coupling_id)
end
info(pipeline_coupling_id) click to toggle source

Info for an existing pipeline coupling.

@param pipeline_coupling_id: unique identifier of pipeline coupling

# File lib/platform-api/client.rb, line 2473
def info(pipeline_coupling_id)
  @client.pipeline_coupling.info(pipeline_coupling_id)
end
info_by_app(app_id_or_app_name) click to toggle source

Info for an existing pipeline coupling.

@param app_id_or_app_name: unique identifier of app or unique name of app

# File lib/platform-api/client.rb, line 2495
def info_by_app(app_id_or_app_name)
  @client.pipeline_coupling.info_by_app(app_id_or_app_name)
end
list() click to toggle source

List pipeline couplings.

# File lib/platform-api/client.rb, line 2452
def list()
  @client.pipeline_coupling.list()
end
list_by_current_user() click to toggle source

List pipeline couplings for the current user.

# File lib/platform-api/client.rb, line 2447
def list_by_current_user()
  @client.pipeline_coupling.list_by_current_user()
end
list_by_pipeline(pipeline_id) click to toggle source

List couplings for a pipeline

@param pipeline_id: unique identifier of pipeline

# File lib/platform-api/client.rb, line 2442
def list_by_pipeline(pipeline_id)
  @client.pipeline_coupling.list_by_pipeline(pipeline_id)
end
list_by_team(team_name_or_team_id) click to toggle source

List pipeline couplings for a team.

@param team_name_or_team_id: unique name of team or unique identifier of team

# File lib/platform-api/client.rb, line 2459
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 = {}) click to toggle source

Update an existing pipeline coupling.

@param pipeline_coupling_id: unique identifier of pipeline coupling @param body: the object to pass as the request payload

# File lib/platform-api/client.rb, line 2488
def update(pipeline_coupling_id, body = {})
  @client.pipeline_coupling.update(pipeline_coupling_id, body)
end