Class: PlatformAPI::PipelineConfigVar

Inherits:

Object

• Object
• PlatformAPI::PipelineConfigVar

Defined in:

lib/platform-api/client.rb

Overview

Pipeline Config Vars allow you to manage the configuration information provided to a pipeline.

Instance Method Summary

• #info_for_app(pipeline_id, pipeline_coupling_stage) ⇒ Object

  Get config-vars for a pipeline stage.

• #initialize(client) ⇒ PipelineConfigVar constructor

  A new instance of PipelineConfigVar.

• #update(pipeline_id, pipeline_coupling_stage, body = {}) ⇒ Object

  Update config-vars for a pipeline stage.

Constructor Details

#initialize(client) ⇒ PipelineConfigVar

Returns a new instance of PipelineConfigVar.

# File 'lib/platform-api/client.rb', line 2393

def initialize(client)
  @client = client
end

Instance Method Details

#info_for_app(pipeline_id, pipeline_coupling_stage) ⇒ Object

Get config-vars for a pipeline stage.

Parameters:

• pipeline_id: —

  unique identifier of pipeline

• pipeline_coupling_stage: —

  target pipeline stage

# File 'lib/platform-api/client.rb', line 2401

def info_for_app(pipeline_id, pipeline_coupling_stage)
  @client.pipeline_config_var.info_for_app(pipeline_id, pipeline_coupling_stage)
end

#update(pipeline_id, pipeline_coupling_stage, body = {}) ⇒ Object

Update config-vars for a pipeline stage. You can update existing config-vars by setting them again, and remove by setting it to null.

Parameters:

• pipeline_id: —

  unique identifier of pipeline

• pipeline_coupling_stage: —

  target pipeline stage

• body: —

  the object to pass as the request payload

# File 'lib/platform-api/client.rb', line 2410

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