class SwaggerClient::V2PipelineTemplatesControllerApi

Attributes

api_client[RW]

Public Class Methods

new(api_client = ApiClient.default) click to toggle source
# File lib/swagger_client/api/v2_pipeline_templates_controller_api.rb, line 19
def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Public Instance Methods

create_using_post1(pipeline_template, opts = {}) click to toggle source

(ALPHA) Create a pipeline template. @param pipeline_template pipelineTemplate @param [Hash] opts the optional parameters @option opts [String] :tag tag @return [nil]

# File lib/swagger_client/api/v2_pipeline_templates_controller_api.rb, line 27
def create_using_post1(pipeline_template, opts = {})
  create_using_post1_with_http_info(pipeline_template, opts)
  nil
end
create_using_post1_with_http_info(pipeline_template, opts = {}) click to toggle source

(ALPHA) Create a pipeline template. @param pipeline_template pipelineTemplate @param [Hash] opts the optional parameters @option opts [String] :tag tag @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers

# File lib/swagger_client/api/v2_pipeline_templates_controller_api.rb, line 37
def create_using_post1_with_http_info(pipeline_template, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: V2PipelineTemplatesControllerApi.create_using_post1 ...'
  end
  # verify the required parameter 'pipeline_template' is set
  if @api_client.config.client_side_validation && pipeline_template.nil?
    fail ArgumentError, "Missing the required parameter 'pipeline_template' when calling V2PipelineTemplatesControllerApi.create_using_post1"
  end
  # resource path
  local_var_path = '/v2/pipelineTemplates/create'

  # query parameters
  query_params = {}
  query_params[:'tag'] = opts[:'tag'] if !opts[:'tag'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(pipeline_template)
  auth_names = []
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: V2PipelineTemplatesControllerApi#create_using_post1\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
delete_using_delete1(id, opts = {}) click to toggle source

Delete a pipeline template. @param id id @param [Hash] opts the optional parameters @option opts [String] :tag tag @option opts [String] :digest digest @option opts [String] :application application @return [Hash<String, Object>]

# File lib/swagger_client/api/v2_pipeline_templates_controller_api.rb, line 83
def delete_using_delete1(id, opts = {})
  data, _status_code, _headers = delete_using_delete1_with_http_info(id, opts)
  data
end
delete_using_delete1_with_http_info(id, opts = {}) click to toggle source

Delete a pipeline template. @param id id @param [Hash] opts the optional parameters @option opts [String] :tag tag @option opts [String] :digest digest @option opts [String] :application application @return [Array<(Hash<String, Object>, Fixnum, Hash)>] Hash<String, Object> data, response status code and response headers

# File lib/swagger_client/api/v2_pipeline_templates_controller_api.rb, line 95
def delete_using_delete1_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: V2PipelineTemplatesControllerApi.delete_using_delete1 ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling V2PipelineTemplatesControllerApi.delete_using_delete1"
  end
  # resource path
  local_var_path = '/v2/pipelineTemplates/{id}'.sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}
  query_params[:'tag'] = opts[:'tag'] if !opts[:'tag'].nil?
  query_params[:'digest'] = opts[:'digest'] if !opts[:'digest'].nil?
  query_params[:'application'] = opts[:'application'] if !opts[:'application'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Hash<String, Object>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: V2PipelineTemplatesControllerApi#delete_using_delete1\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_using_get2(id, opts = {}) click to toggle source

(ALPHA) Get a pipeline template. @param id id @param [Hash] opts the optional parameters @option opts [String] :tag tag @option opts [String] :digest digest @return [Hash<String, Object>]

# File lib/swagger_client/api/v2_pipeline_templates_controller_api.rb, line 143
def get_using_get2(id, opts = {})
  data, _status_code, _headers = get_using_get2_with_http_info(id, opts)
  data
end
get_using_get2_with_http_info(id, opts = {}) click to toggle source

(ALPHA) Get a pipeline template. @param id id @param [Hash] opts the optional parameters @option opts [String] :tag tag @option opts [String] :digest digest @return [Array<(Hash<String, Object>, Fixnum, Hash)>] Hash<String, Object> data, response status code and response headers

# File lib/swagger_client/api/v2_pipeline_templates_controller_api.rb, line 154
def get_using_get2_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: V2PipelineTemplatesControllerApi.get_using_get2 ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling V2PipelineTemplatesControllerApi.get_using_get2"
  end
  # resource path
  local_var_path = '/v2/pipelineTemplates/{id}'.sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}
  query_params[:'tag'] = opts[:'tag'] if !opts[:'tag'].nil?
  query_params[:'digest'] = opts[:'digest'] if !opts[:'digest'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Hash<String, Object>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: V2PipelineTemplatesControllerApi#get_using_get2\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
list_pipeline_template_dependents_using_get1(id, opts = {}) click to toggle source

(ALPHA) List all pipelines that implement a pipeline template @param id id @param [Hash] opts the optional parameters @return [Array<Object>]

# File lib/swagger_client/api/v2_pipeline_templates_controller_api.rb, line 199
def list_pipeline_template_dependents_using_get1(id, opts = {})
  data, _status_code, _headers = list_pipeline_template_dependents_using_get1_with_http_info(id, opts)
  data
end
list_pipeline_template_dependents_using_get1_with_http_info(id, opts = {}) click to toggle source

(ALPHA) List all pipelines that implement a pipeline template @param id id @param [Hash] opts the optional parameters @return [Array<(Array<Object>, Fixnum, Hash)>] Array<Object> data, response status code and response headers

# File lib/swagger_client/api/v2_pipeline_templates_controller_api.rb, line 208
def list_pipeline_template_dependents_using_get1_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: V2PipelineTemplatesControllerApi.list_pipeline_template_dependents_using_get1 ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling V2PipelineTemplatesControllerApi.list_pipeline_template_dependents_using_get1"
  end
  # resource path
  local_var_path = '/v2/pipelineTemplates/{id}/dependents'.sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Array<Object>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: V2PipelineTemplatesControllerApi#list_pipeline_template_dependents_using_get1\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
list_using_get1(opts = {}) click to toggle source

(ALPHA) List pipeline templates. @param [Hash] opts the optional parameters @option opts [Array<String>] :scopes scopes @return [Array<Object>]

# File lib/swagger_client/api/v2_pipeline_templates_controller_api.rb, line 251
def list_using_get1(opts = {})
  data, _status_code, _headers = list_using_get1_with_http_info(opts)
  data
end
list_using_get1_with_http_info(opts = {}) click to toggle source

(ALPHA) List pipeline templates. @param [Hash] opts the optional parameters @option opts [Array<String>] :scopes scopes @return [Array<(Array<Object>, Fixnum, Hash)>] Array<Object> data, response status code and response headers

# File lib/swagger_client/api/v2_pipeline_templates_controller_api.rb, line 260
def list_using_get1_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: V2PipelineTemplatesControllerApi.list_using_get1 ...'
  end
  # resource path
  local_var_path = '/v2/pipelineTemplates'

  # query parameters
  query_params = {}
  query_params[:'scopes'] = @api_client.build_collection_param(opts[:'scopes'], :multi) if !opts[:'scopes'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Array<Object>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: V2PipelineTemplatesControllerApi#list_using_get1\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
plan_using_post(pipeline, opts = {}) click to toggle source

(ALPHA) Plan a pipeline template configuration. @param pipeline pipeline @param [Hash] opts the optional parameters @return [Hash<String, Object>]

# File lib/swagger_client/api/v2_pipeline_templates_controller_api.rb, line 300
def plan_using_post(pipeline, opts = {})
  data, _status_code, _headers = plan_using_post_with_http_info(pipeline, opts)
  data
end
plan_using_post_with_http_info(pipeline, opts = {}) click to toggle source

(ALPHA) Plan a pipeline template configuration. @param pipeline pipeline @param [Hash] opts the optional parameters @return [Array<(Hash<String, Object>, Fixnum, Hash)>] Hash<String, Object> data, response status code and response headers

# File lib/swagger_client/api/v2_pipeline_templates_controller_api.rb, line 309
def plan_using_post_with_http_info(pipeline, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: V2PipelineTemplatesControllerApi.plan_using_post ...'
  end
  # verify the required parameter 'pipeline' is set
  if @api_client.config.client_side_validation && pipeline.nil?
    fail ArgumentError, "Missing the required parameter 'pipeline' when calling V2PipelineTemplatesControllerApi.plan_using_post"
  end
  # resource path
  local_var_path = '/v2/pipelineTemplates/plan'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(pipeline)
  auth_names = []
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Hash<String, Object>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: V2PipelineTemplatesControllerApi#plan_using_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
update_using_post1(id, pipeline_template, opts = {}) click to toggle source

(ALPHA) Update a pipeline template. @param id id @param pipeline_template pipelineTemplate @param [Hash] opts the optional parameters @option opts [String] :tag tag @option opts [BOOLEAN] :skip_plan_dependents skipPlanDependents (default to false) @return [nil]

# File lib/swagger_client/api/v2_pipeline_templates_controller_api.rb, line 355
def update_using_post1(id, pipeline_template, opts = {})
  update_using_post1_with_http_info(id, pipeline_template, opts)
  nil
end
update_using_post1_with_http_info(id, pipeline_template, opts = {}) click to toggle source

(ALPHA) Update a pipeline template. @param id id @param pipeline_template pipelineTemplate @param [Hash] opts the optional parameters @option opts [String] :tag tag @option opts [BOOLEAN] :skip_plan_dependents skipPlanDependents @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers

# File lib/swagger_client/api/v2_pipeline_templates_controller_api.rb, line 367
def update_using_post1_with_http_info(id, pipeline_template, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: V2PipelineTemplatesControllerApi.update_using_post1 ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling V2PipelineTemplatesControllerApi.update_using_post1"
  end
  # verify the required parameter 'pipeline_template' is set
  if @api_client.config.client_side_validation && pipeline_template.nil?
    fail ArgumentError, "Missing the required parameter 'pipeline_template' when calling V2PipelineTemplatesControllerApi.update_using_post1"
  end
  # resource path
  local_var_path = '/v2/pipelineTemplates/update/{id}'.sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}
  query_params[:'tag'] = opts[:'tag'] if !opts[:'tag'].nil?
  query_params[:'skipPlanDependents'] = opts[:'skip_plan_dependents'] if !opts[:'skip_plan_dependents'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(pipeline_template)
  auth_names = []
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: V2PipelineTemplatesControllerApi#update_using_post1\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end