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.



1901
1902
1903
 
# File 'lib/platform-api/client.rb', line 1901

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



1913
1914
1915
 
# File 'lib/platform-api/client.rb', line 1913

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



1927
1928
1929
 
# File 'lib/platform-api/client.rb', line 1927

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

#info(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



1920
1921
1922
 
# File 'lib/platform-api/client.rb', line 1920

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

#list ⇒ Object

List pipeline couplings.



1906
1907
1908
 
# File 'lib/platform-api/client.rb', line 1906

def list()
  @client.pipeline_coupling.list()
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



1935
1936
1937
 
# File 'lib/platform-api/client.rb', line 1935

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