Class: PlatformAPI::PipelineConfigVar

Inherits:
Object
  • Object
show all
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 collapse

Constructor Details

#initialize(client) ⇒ PipelineConfigVar

Returns a new instance of PipelineConfigVar.



2411
2412
2413
# File 'lib/platform-api/client.rb', line 2411

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



2419
2420
2421
# File 'lib/platform-api/client.rb', line 2419

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



2428
2429
2430
# File 'lib/platform-api/client.rb', line 2428

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