class SwaggyJenkinsClient::BlueOceanApi

Attributes

api_client[RW]

Public Class Methods

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

Public Instance Methods

delete_pipeline_queue_item(organization, pipeline, queue, opts = {}) click to toggle source

Delete queue item from an organization pipeline queue @param organization Name of the organization @param pipeline Name of the pipeline @param queue Name of the queue item @param [Hash] opts the optional parameters @return [nil]

# File lib/swaggy_jenkins/api/blue_ocean_api.rb, line 30
def delete_pipeline_queue_item(organization, pipeline, queue, opts = {})
  delete_pipeline_queue_item_with_http_info(organization, pipeline, queue, opts)
  return nil
end
delete_pipeline_queue_item_with_http_info(organization, pipeline, queue, opts = {}) click to toggle source

Delete queue item from an organization pipeline queue @param organization Name of the organization @param pipeline Name of the pipeline @param queue Name of the queue item @param [Hash] opts the optional parameters @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers

# File lib/swaggy_jenkins/api/blue_ocean_api.rb, line 42
def delete_pipeline_queue_item_with_http_info(organization, pipeline, queue, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: BlueOceanApi.delete_pipeline_queue_item ..."
  end
  # verify the required parameter 'organization' is set
  if @api_client.config.client_side_validation && organization.nil?
    fail ArgumentError, "Missing the required parameter 'organization' when calling BlueOceanApi.delete_pipeline_queue_item"
  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 BlueOceanApi.delete_pipeline_queue_item"
  end
  # verify the required parameter 'queue' is set
  if @api_client.config.client_side_validation && queue.nil?
    fail ArgumentError, "Missing the required parameter 'queue' when calling BlueOceanApi.delete_pipeline_queue_item"
  end
  # resource path
  local_var_path = "/blue/rest/organizations/{organization}/pipelines/{pipeline}/queue/{queue}".sub('{' + 'organization' + '}', organization.to_s).sub('{' + 'pipeline' + '}', pipeline.to_s).sub('{' + 'queue' + '}', queue.to_s)

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['jenkins_auth']
  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)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BlueOceanApi#delete_pipeline_queue_item\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_authenticated_user(organization, opts = {}) click to toggle source

Retrieve authenticated user details for an organization @param organization Name of the organization @param [Hash] opts the optional parameters @return [User]

# File lib/swaggy_jenkins/api/blue_ocean_api.rb, line 92
def get_authenticated_user(organization, opts = {})
  data, _status_code, _headers = get_authenticated_user_with_http_info(organization, opts)
  return data
end
get_authenticated_user_with_http_info(organization, opts = {}) click to toggle source

Retrieve authenticated user details for an organization @param organization Name of the organization @param [Hash] opts the optional parameters @return [Array<(User, Fixnum, Hash)>] User data, response status code and response headers

# File lib/swaggy_jenkins/api/blue_ocean_api.rb, line 102
def get_authenticated_user_with_http_info(organization, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: BlueOceanApi.get_authenticated_user ..."
  end
  # verify the required parameter 'organization' is set
  if @api_client.config.client_side_validation && organization.nil?
    fail ArgumentError, "Missing the required parameter 'organization' when calling BlueOceanApi.get_authenticated_user"
  end
  # resource path
  local_var_path = "/blue/rest/organizations/{organization}/user/".sub('{' + 'organization' + '}', organization.to_s)

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['jenkins_auth']
  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 => 'User')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BlueOceanApi#get_authenticated_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_classes(_class, opts = {}) click to toggle source

Get a list of class names supported by a given class @param _class Name of the class @param [Hash] opts the optional parameters @return [String]

# File lib/swaggy_jenkins/api/blue_ocean_api.rb, line 145
def get_classes(_class, opts = {})
  data, _status_code, _headers = get_classes_with_http_info(_class, opts)
  return data
end
get_classes_with_http_info(_class, opts = {}) click to toggle source

Get a list of class names supported by a given class @param _class Name of the class @param [Hash] opts the optional parameters @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers

# File lib/swaggy_jenkins/api/blue_ocean_api.rb, line 155
def get_classes_with_http_info(_class, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: BlueOceanApi.get_classes ..."
  end
  # verify the required parameter '_class' is set
  if @api_client.config.client_side_validation && _class.nil?
    fail ArgumentError, "Missing the required parameter '_class' when calling BlueOceanApi.get_classes"
  end
  # resource path
  local_var_path = "/blue/rest/classes/{class}".sub('{' + 'class' + '}', _class.to_s)

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['jenkins_auth']
  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 => 'String')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BlueOceanApi#get_classes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_organisation(organization, opts = {}) click to toggle source

Retrieve organization details @param organization Name of the organization @param [Hash] opts the optional parameters @return [Organisation]

# File lib/swaggy_jenkins/api/blue_ocean_api.rb, line 198
def get_organisation(organization, opts = {})
  data, _status_code, _headers = get_organisation_with_http_info(organization, opts)
  return data
end
get_organisation_with_http_info(organization, opts = {}) click to toggle source

Retrieve organization details @param organization Name of the organization @param [Hash] opts the optional parameters @return [Array<(Organisation, Fixnum, Hash)>] Organisation data, response status code and response headers

# File lib/swaggy_jenkins/api/blue_ocean_api.rb, line 208
def get_organisation_with_http_info(organization, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: BlueOceanApi.get_organisation ..."
  end
  # verify the required parameter 'organization' is set
  if @api_client.config.client_side_validation && organization.nil?
    fail ArgumentError, "Missing the required parameter 'organization' when calling BlueOceanApi.get_organisation"
  end
  # resource path
  local_var_path = "/blue/rest/organizations/{organization}".sub('{' + 'organization' + '}', organization.to_s)

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['jenkins_auth']
  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 => 'Organisation')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BlueOceanApi#get_organisation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_organisations(opts = {}) click to toggle source

Retrieve all organizations details @param [Hash] opts the optional parameters @return [Organisations]

# File lib/swaggy_jenkins/api/blue_ocean_api.rb, line 250
def get_organisations(opts = {})
  data, _status_code, _headers = get_organisations_with_http_info(opts)
  return data
end
get_organisations_with_http_info(opts = {}) click to toggle source

Retrieve all organizations details @param [Hash] opts the optional parameters @return [Array<(Organisations, Fixnum, Hash)>] Organisations data, response status code and response headers

# File lib/swaggy_jenkins/api/blue_ocean_api.rb, line 259
def get_organisations_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: BlueOceanApi.get_organisations ..."
  end
  # resource path
  local_var_path = "/blue/rest/organizations/"

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['jenkins_auth']
  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 => 'Organisations')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BlueOceanApi#get_organisations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_pipeline(organization, pipeline, opts = {}) click to toggle source

Retrieve pipeline details for an organization @param organization Name of the organization @param pipeline Name of the pipeline @param [Hash] opts the optional parameters @return [Pipeline]

# File lib/swaggy_jenkins/api/blue_ocean_api.rb, line 299
def get_pipeline(organization, pipeline, opts = {})
  data, _status_code, _headers = get_pipeline_with_http_info(organization, pipeline, opts)
  return data
end
get_pipeline_activities(organization, pipeline, opts = {}) click to toggle source

Retrieve all activities details for an organization pipeline @param organization Name of the organization @param pipeline Name of the pipeline @param [Hash] opts the optional parameters @return [PipelineActivities]

# File lib/swaggy_jenkins/api/blue_ocean_api.rb, line 358
def get_pipeline_activities(organization, pipeline, opts = {})
  data, _status_code, _headers = get_pipeline_activities_with_http_info(organization, pipeline, opts)
  return data
end
get_pipeline_activities_with_http_info(organization, pipeline, opts = {}) click to toggle source

Retrieve all activities details for an organization pipeline @param organization Name of the organization @param pipeline Name of the pipeline @param [Hash] opts the optional parameters @return [Array<(PipelineActivities, Fixnum, Hash)>] PipelineActivities data, response status code and response headers

# File lib/swaggy_jenkins/api/blue_ocean_api.rb, line 369
def get_pipeline_activities_with_http_info(organization, pipeline, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: BlueOceanApi.get_pipeline_activities ..."
  end
  # verify the required parameter 'organization' is set
  if @api_client.config.client_side_validation && organization.nil?
    fail ArgumentError, "Missing the required parameter 'organization' when calling BlueOceanApi.get_pipeline_activities"
  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 BlueOceanApi.get_pipeline_activities"
  end
  # resource path
  local_var_path = "/blue/rest/organizations/{organization}/pipelines/{pipeline}/activities".sub('{' + 'organization' + '}', organization.to_s).sub('{' + 'pipeline' + '}', pipeline.to_s)

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['jenkins_auth']
  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 => 'PipelineActivities')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BlueOceanApi#get_pipeline_activities\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_pipeline_branch(organization, pipeline, branch, opts = {}) click to toggle source

Retrieve branch details for an organization pipeline @param organization Name of the organization @param pipeline Name of the pipeline @param branch Name of the branch @param [Hash] opts the optional parameters @return [BranchImpl]

# File lib/swaggy_jenkins/api/blue_ocean_api.rb, line 418
def get_pipeline_branch(organization, pipeline, branch, opts = {})
  data, _status_code, _headers = get_pipeline_branch_with_http_info(organization, pipeline, branch, opts)
  return data
end
get_pipeline_branch_run(organization, pipeline, branch, run, opts = {}) click to toggle source

Retrieve branch run details for an organization pipeline @param organization Name of the organization @param pipeline Name of the pipeline @param branch Name of the branch @param run Name of the run @param [Hash] opts the optional parameters @return [PipelineRun]

# File lib/swaggy_jenkins/api/blue_ocean_api.rb, line 484
def get_pipeline_branch_run(organization, pipeline, branch, run, opts = {})
  data, _status_code, _headers = get_pipeline_branch_run_with_http_info(organization, pipeline, branch, run, opts)
  return data
end
get_pipeline_branch_run_with_http_info(organization, pipeline, branch, run, opts = {}) click to toggle source

Retrieve branch run details for an organization pipeline @param organization Name of the organization @param pipeline Name of the pipeline @param branch Name of the branch @param run Name of the run @param [Hash] opts the optional parameters @return [Array<(PipelineRun, Fixnum, Hash)>] PipelineRun data, response status code and response headers

# File lib/swaggy_jenkins/api/blue_ocean_api.rb, line 497
def get_pipeline_branch_run_with_http_info(organization, pipeline, branch, run, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: BlueOceanApi.get_pipeline_branch_run ..."
  end
  # verify the required parameter 'organization' is set
  if @api_client.config.client_side_validation && organization.nil?
    fail ArgumentError, "Missing the required parameter 'organization' when calling BlueOceanApi.get_pipeline_branch_run"
  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 BlueOceanApi.get_pipeline_branch_run"
  end
  # verify the required parameter 'branch' is set
  if @api_client.config.client_side_validation && branch.nil?
    fail ArgumentError, "Missing the required parameter 'branch' when calling BlueOceanApi.get_pipeline_branch_run"
  end
  # verify the required parameter 'run' is set
  if @api_client.config.client_side_validation && run.nil?
    fail ArgumentError, "Missing the required parameter 'run' when calling BlueOceanApi.get_pipeline_branch_run"
  end
  # resource path
  local_var_path = "/blue/rest/organizations/{organization}/pipelines/{pipeline}/branches/{branch}/runs/{run}".sub('{' + 'organization' + '}', organization.to_s).sub('{' + 'pipeline' + '}', pipeline.to_s).sub('{' + 'branch' + '}', branch.to_s).sub('{' + 'run' + '}', run.to_s)

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['jenkins_auth']
  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 => 'PipelineRun')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BlueOceanApi#get_pipeline_branch_run\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_pipeline_branch_with_http_info(organization, pipeline, branch, opts = {}) click to toggle source

Retrieve branch details for an organization pipeline @param organization Name of the organization @param pipeline Name of the pipeline @param branch Name of the branch @param [Hash] opts the optional parameters @return [Array<(BranchImpl, Fixnum, Hash)>] BranchImpl data, response status code and response headers

# File lib/swaggy_jenkins/api/blue_ocean_api.rb, line 430
def get_pipeline_branch_with_http_info(organization, pipeline, branch, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: BlueOceanApi.get_pipeline_branch ..."
  end
  # verify the required parameter 'organization' is set
  if @api_client.config.client_side_validation && organization.nil?
    fail ArgumentError, "Missing the required parameter 'organization' when calling BlueOceanApi.get_pipeline_branch"
  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 BlueOceanApi.get_pipeline_branch"
  end
  # verify the required parameter 'branch' is set
  if @api_client.config.client_side_validation && branch.nil?
    fail ArgumentError, "Missing the required parameter 'branch' when calling BlueOceanApi.get_pipeline_branch"
  end
  # resource path
  local_var_path = "/blue/rest/organizations/{organization}/pipelines/{pipeline}/branches/{branch}/".sub('{' + 'organization' + '}', organization.to_s).sub('{' + 'pipeline' + '}', pipeline.to_s).sub('{' + 'branch' + '}', branch.to_s)

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['jenkins_auth']
  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 => 'BranchImpl')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BlueOceanApi#get_pipeline_branch\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_pipeline_branches(organization, pipeline, opts = {}) click to toggle source

Retrieve all branches details for an organization pipeline @param organization Name of the organization @param pipeline Name of the pipeline @param [Hash] opts the optional parameters @return [MultibranchPipeline]

# File lib/swaggy_jenkins/api/blue_ocean_api.rb, line 553
def get_pipeline_branches(organization, pipeline, opts = {})
  data, _status_code, _headers = get_pipeline_branches_with_http_info(organization, pipeline, opts)
  return data
end
get_pipeline_branches_with_http_info(organization, pipeline, opts = {}) click to toggle source

Retrieve all branches details for an organization pipeline @param organization Name of the organization @param pipeline Name of the pipeline @param [Hash] opts the optional parameters @return [Array<(MultibranchPipeline, Fixnum, Hash)>] MultibranchPipeline data, response status code and response headers

# File lib/swaggy_jenkins/api/blue_ocean_api.rb, line 564
def get_pipeline_branches_with_http_info(organization, pipeline, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: BlueOceanApi.get_pipeline_branches ..."
  end
  # verify the required parameter 'organization' is set
  if @api_client.config.client_side_validation && organization.nil?
    fail ArgumentError, "Missing the required parameter 'organization' when calling BlueOceanApi.get_pipeline_branches"
  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 BlueOceanApi.get_pipeline_branches"
  end
  # resource path
  local_var_path = "/blue/rest/organizations/{organization}/pipelines/{pipeline}/branches".sub('{' + 'organization' + '}', organization.to_s).sub('{' + 'pipeline' + '}', pipeline.to_s)

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['jenkins_auth']
  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 => 'MultibranchPipeline')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BlueOceanApi#get_pipeline_branches\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_pipeline_folder(organization, folder, opts = {}) click to toggle source

Retrieve pipeline folder for an organization @param organization Name of the organization @param folder Name of the folder @param [Hash] opts the optional parameters @return [PipelineFolderImpl]

# File lib/swaggy_jenkins/api/blue_ocean_api.rb, line 612
def get_pipeline_folder(organization, folder, opts = {})
  data, _status_code, _headers = get_pipeline_folder_with_http_info(organization, folder, opts)
  return data
end
get_pipeline_folder_pipeline(organization, pipeline, folder, opts = {}) click to toggle source

Retrieve pipeline details for an organization folder @param organization Name of the organization @param pipeline Name of the pipeline @param folder Name of the folder @param [Hash] opts the optional parameters @return [PipelineImpl]

# File lib/swaggy_jenkins/api/blue_ocean_api.rb, line 672
def get_pipeline_folder_pipeline(organization, pipeline, folder, opts = {})
  data, _status_code, _headers = get_pipeline_folder_pipeline_with_http_info(organization, pipeline, folder, opts)
  return data
end
get_pipeline_folder_pipeline_with_http_info(organization, pipeline, folder, opts = {}) click to toggle source

Retrieve pipeline details for an organization folder @param organization Name of the organization @param pipeline Name of the pipeline @param folder Name of the folder @param [Hash] opts the optional parameters @return [Array<(PipelineImpl, Fixnum, Hash)>] PipelineImpl data, response status code and response headers

# File lib/swaggy_jenkins/api/blue_ocean_api.rb, line 684
def get_pipeline_folder_pipeline_with_http_info(organization, pipeline, folder, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: BlueOceanApi.get_pipeline_folder_pipeline ..."
  end
  # verify the required parameter 'organization' is set
  if @api_client.config.client_side_validation && organization.nil?
    fail ArgumentError, "Missing the required parameter 'organization' when calling BlueOceanApi.get_pipeline_folder_pipeline"
  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 BlueOceanApi.get_pipeline_folder_pipeline"
  end
  # verify the required parameter 'folder' is set
  if @api_client.config.client_side_validation && folder.nil?
    fail ArgumentError, "Missing the required parameter 'folder' when calling BlueOceanApi.get_pipeline_folder_pipeline"
  end
  # resource path
  local_var_path = "/blue/rest/organizations/{organization}/pipelines/{folder}/pipelines/{pipeline}".sub('{' + 'organization' + '}', organization.to_s).sub('{' + 'pipeline' + '}', pipeline.to_s).sub('{' + 'folder' + '}', folder.to_s)

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['jenkins_auth']
  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 => 'PipelineImpl')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BlueOceanApi#get_pipeline_folder_pipeline\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_pipeline_folder_with_http_info(organization, folder, opts = {}) click to toggle source

Retrieve pipeline folder for an organization @param organization Name of the organization @param folder Name of the folder @param [Hash] opts the optional parameters @return [Array<(PipelineFolderImpl, Fixnum, Hash)>] PipelineFolderImpl data, response status code and response headers

# File lib/swaggy_jenkins/api/blue_ocean_api.rb, line 623
def get_pipeline_folder_with_http_info(organization, folder, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: BlueOceanApi.get_pipeline_folder ..."
  end
  # verify the required parameter 'organization' is set
  if @api_client.config.client_side_validation && organization.nil?
    fail ArgumentError, "Missing the required parameter 'organization' when calling BlueOceanApi.get_pipeline_folder"
  end
  # verify the required parameter 'folder' is set
  if @api_client.config.client_side_validation && folder.nil?
    fail ArgumentError, "Missing the required parameter 'folder' when calling BlueOceanApi.get_pipeline_folder"
  end
  # resource path
  local_var_path = "/blue/rest/organizations/{organization}/pipelines/{folder}/".sub('{' + 'organization' + '}', organization.to_s).sub('{' + 'folder' + '}', folder.to_s)

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['jenkins_auth']
  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 => 'PipelineFolderImpl')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BlueOceanApi#get_pipeline_folder\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_pipeline_queue(organization, pipeline, opts = {}) click to toggle source

Retrieve queue details for an organization pipeline @param organization Name of the organization @param pipeline Name of the pipeline @param [Hash] opts the optional parameters @return [PipelineQueue]

# File lib/swaggy_jenkins/api/blue_ocean_api.rb, line 736
def get_pipeline_queue(organization, pipeline, opts = {})
  data, _status_code, _headers = get_pipeline_queue_with_http_info(organization, pipeline, opts)
  return data
end
get_pipeline_queue_with_http_info(organization, pipeline, opts = {}) click to toggle source

Retrieve queue details for an organization pipeline @param organization Name of the organization @param pipeline Name of the pipeline @param [Hash] opts the optional parameters @return [Array<(PipelineQueue, Fixnum, Hash)>] PipelineQueue data, response status code and response headers

# File lib/swaggy_jenkins/api/blue_ocean_api.rb, line 747
def get_pipeline_queue_with_http_info(organization, pipeline, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: BlueOceanApi.get_pipeline_queue ..."
  end
  # verify the required parameter 'organization' is set
  if @api_client.config.client_side_validation && organization.nil?
    fail ArgumentError, "Missing the required parameter 'organization' when calling BlueOceanApi.get_pipeline_queue"
  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 BlueOceanApi.get_pipeline_queue"
  end
  # resource path
  local_var_path = "/blue/rest/organizations/{organization}/pipelines/{pipeline}/queue".sub('{' + 'organization' + '}', organization.to_s).sub('{' + 'pipeline' + '}', pipeline.to_s)

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['jenkins_auth']
  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 => 'PipelineQueue')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BlueOceanApi#get_pipeline_queue\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_pipeline_run(organization, pipeline, run, opts = {}) click to toggle source

Retrieve run details for an organization pipeline @param organization Name of the organization @param pipeline Name of the pipeline @param run Name of the run @param [Hash] opts the optional parameters @return [PipelineRun]

# File lib/swaggy_jenkins/api/blue_ocean_api.rb, line 796
def get_pipeline_run(organization, pipeline, run, opts = {})
  data, _status_code, _headers = get_pipeline_run_with_http_info(organization, pipeline, run, opts)
  return data
end
get_pipeline_run_log(organization, pipeline, run, opts = {}) click to toggle source

Get log for a pipeline run @param organization Name of the organization @param pipeline Name of the pipeline @param run Name of the run @param [Hash] opts the optional parameters @option opts [Integer] :start Start position of the log @option opts [BOOLEAN] :download Set to true in order to download the file, otherwise it&#39;s passed as a response body @return [String]

# File lib/swaggy_jenkins/api/blue_ocean_api.rb, line 863
def get_pipeline_run_log(organization, pipeline, run, opts = {})
  data, _status_code, _headers = get_pipeline_run_log_with_http_info(organization, pipeline, run, opts)
  return data
end
get_pipeline_run_log_with_http_info(organization, pipeline, run, opts = {}) click to toggle source

Get log for a pipeline run @param organization Name of the organization @param pipeline Name of the pipeline @param run Name of the run @param [Hash] opts the optional parameters @option opts [Integer] :start Start position of the log @option opts [BOOLEAN] :download Set to true in order to download the file, otherwise it&#39;s passed as a response body @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers

# File lib/swaggy_jenkins/api/blue_ocean_api.rb, line 877
def get_pipeline_run_log_with_http_info(organization, pipeline, run, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: BlueOceanApi.get_pipeline_run_log ..."
  end
  # verify the required parameter 'organization' is set
  if @api_client.config.client_side_validation && organization.nil?
    fail ArgumentError, "Missing the required parameter 'organization' when calling BlueOceanApi.get_pipeline_run_log"
  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 BlueOceanApi.get_pipeline_run_log"
  end
  # verify the required parameter 'run' is set
  if @api_client.config.client_side_validation && run.nil?
    fail ArgumentError, "Missing the required parameter 'run' when calling BlueOceanApi.get_pipeline_run_log"
  end
  # resource path
  local_var_path = "/blue/rest/organizations/{organization}/pipelines/{pipeline}/runs/{run}/log".sub('{' + 'organization' + '}', organization.to_s).sub('{' + 'pipeline' + '}', pipeline.to_s).sub('{' + 'run' + '}', run.to_s)

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['jenkins_auth']
  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 => 'String')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BlueOceanApi#get_pipeline_run_log\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_pipeline_run_node(organization, pipeline, run, node, opts = {}) click to toggle source

Retrieve run node details for an organization pipeline @param organization Name of the organization @param pipeline Name of the pipeline @param run Name of the run @param node Name of the node @param [Hash] opts the optional parameters @return [PipelineRunNode]

# File lib/swaggy_jenkins/api/blue_ocean_api.rb, line 933
def get_pipeline_run_node(organization, pipeline, run, node, opts = {})
  data, _status_code, _headers = get_pipeline_run_node_with_http_info(organization, pipeline, run, node, opts)
  return data
end
get_pipeline_run_node_step(organization, pipeline, run, node, step, opts = {}) click to toggle source

Retrieve run node details for an organization pipeline @param organization Name of the organization @param pipeline Name of the pipeline @param run Name of the run @param node Name of the node @param step Name of the step @param [Hash] opts the optional parameters @return [PipelineStepImpl]

# File lib/swaggy_jenkins/api/blue_ocean_api.rb, line 1005
def get_pipeline_run_node_step(organization, pipeline, run, node, step, opts = {})
  data, _status_code, _headers = get_pipeline_run_node_step_with_http_info(organization, pipeline, run, node, step, opts)
  return data
end
get_pipeline_run_node_step_log(organization, pipeline, run, node, step, opts = {}) click to toggle source

Get log for a pipeline run node step @param organization Name of the organization @param pipeline Name of the pipeline @param run Name of the run @param node Name of the node @param step Name of the step @param [Hash] opts the optional parameters @return [String]

# File lib/swaggy_jenkins/api/blue_ocean_api.rb, line 1082
def get_pipeline_run_node_step_log(organization, pipeline, run, node, step, opts = {})
  data, _status_code, _headers = get_pipeline_run_node_step_log_with_http_info(organization, pipeline, run, node, step, opts)
  return data
end
get_pipeline_run_node_step_log_with_http_info(organization, pipeline, run, node, step, opts = {}) click to toggle source

Get log for a pipeline run node step @param organization Name of the organization @param pipeline Name of the pipeline @param run Name of the run @param node Name of the node @param step Name of the step @param [Hash] opts the optional parameters @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers

# File lib/swaggy_jenkins/api/blue_ocean_api.rb, line 1096
def get_pipeline_run_node_step_log_with_http_info(organization, pipeline, run, node, step, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: BlueOceanApi.get_pipeline_run_node_step_log ..."
  end
  # verify the required parameter 'organization' is set
  if @api_client.config.client_side_validation && organization.nil?
    fail ArgumentError, "Missing the required parameter 'organization' when calling BlueOceanApi.get_pipeline_run_node_step_log"
  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 BlueOceanApi.get_pipeline_run_node_step_log"
  end
  # verify the required parameter 'run' is set
  if @api_client.config.client_side_validation && run.nil?
    fail ArgumentError, "Missing the required parameter 'run' when calling BlueOceanApi.get_pipeline_run_node_step_log"
  end
  # verify the required parameter 'node' is set
  if @api_client.config.client_side_validation && node.nil?
    fail ArgumentError, "Missing the required parameter 'node' when calling BlueOceanApi.get_pipeline_run_node_step_log"
  end
  # verify the required parameter 'step' is set
  if @api_client.config.client_side_validation && step.nil?
    fail ArgumentError, "Missing the required parameter 'step' when calling BlueOceanApi.get_pipeline_run_node_step_log"
  end
  # resource path
  local_var_path = "/blue/rest/organizations/{organization}/pipelines/{pipeline}/runs/{run}/nodes/{node}/steps/{step}/log".sub('{' + 'organization' + '}', organization.to_s).sub('{' + 'pipeline' + '}', pipeline.to_s).sub('{' + 'run' + '}', run.to_s).sub('{' + 'node' + '}', node.to_s).sub('{' + 'step' + '}', step.to_s)

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['jenkins_auth']
  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 => 'String')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BlueOceanApi#get_pipeline_run_node_step_log\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_pipeline_run_node_step_with_http_info(organization, pipeline, run, node, step, opts = {}) click to toggle source

Retrieve run node details for an organization pipeline @param organization Name of the organization @param pipeline Name of the pipeline @param run Name of the run @param node Name of the node @param step Name of the step @param [Hash] opts the optional parameters @return [Array<(PipelineStepImpl, Fixnum, Hash)>] PipelineStepImpl data, response status code and response headers

# File lib/swaggy_jenkins/api/blue_ocean_api.rb, line 1019
def get_pipeline_run_node_step_with_http_info(organization, pipeline, run, node, step, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: BlueOceanApi.get_pipeline_run_node_step ..."
  end
  # verify the required parameter 'organization' is set
  if @api_client.config.client_side_validation && organization.nil?
    fail ArgumentError, "Missing the required parameter 'organization' when calling BlueOceanApi.get_pipeline_run_node_step"
  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 BlueOceanApi.get_pipeline_run_node_step"
  end
  # verify the required parameter 'run' is set
  if @api_client.config.client_side_validation && run.nil?
    fail ArgumentError, "Missing the required parameter 'run' when calling BlueOceanApi.get_pipeline_run_node_step"
  end
  # verify the required parameter 'node' is set
  if @api_client.config.client_side_validation && node.nil?
    fail ArgumentError, "Missing the required parameter 'node' when calling BlueOceanApi.get_pipeline_run_node_step"
  end
  # verify the required parameter 'step' is set
  if @api_client.config.client_side_validation && step.nil?
    fail ArgumentError, "Missing the required parameter 'step' when calling BlueOceanApi.get_pipeline_run_node_step"
  end
  # resource path
  local_var_path = "/blue/rest/organizations/{organization}/pipelines/{pipeline}/runs/{run}/nodes/{node}/steps/{step}".sub('{' + 'organization' + '}', organization.to_s).sub('{' + 'pipeline' + '}', pipeline.to_s).sub('{' + 'run' + '}', run.to_s).sub('{' + 'node' + '}', node.to_s).sub('{' + 'step' + '}', step.to_s)

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['jenkins_auth']
  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 => 'PipelineStepImpl')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BlueOceanApi#get_pipeline_run_node_step\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_pipeline_run_node_steps(organization, pipeline, run, node, opts = {}) click to toggle source

Retrieve run node steps details for an organization pipeline @param organization Name of the organization @param pipeline Name of the pipeline @param run Name of the run @param node Name of the node @param [Hash] opts the optional parameters @return [PipelineRunNodeSteps]

# File lib/swaggy_jenkins/api/blue_ocean_api.rb, line 1158
def get_pipeline_run_node_steps(organization, pipeline, run, node, opts = {})
  data, _status_code, _headers = get_pipeline_run_node_steps_with_http_info(organization, pipeline, run, node, opts)
  return data
end
get_pipeline_run_node_steps_with_http_info(organization, pipeline, run, node, opts = {}) click to toggle source

Retrieve run node steps details for an organization pipeline @param organization Name of the organization @param pipeline Name of the pipeline @param run Name of the run @param node Name of the node @param [Hash] opts the optional parameters @return [Array<(PipelineRunNodeSteps, Fixnum, Hash)>] PipelineRunNodeSteps data, response status code and response headers

# File lib/swaggy_jenkins/api/blue_ocean_api.rb, line 1171
def get_pipeline_run_node_steps_with_http_info(organization, pipeline, run, node, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: BlueOceanApi.get_pipeline_run_node_steps ..."
  end
  # verify the required parameter 'organization' is set
  if @api_client.config.client_side_validation && organization.nil?
    fail ArgumentError, "Missing the required parameter 'organization' when calling BlueOceanApi.get_pipeline_run_node_steps"
  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 BlueOceanApi.get_pipeline_run_node_steps"
  end
  # verify the required parameter 'run' is set
  if @api_client.config.client_side_validation && run.nil?
    fail ArgumentError, "Missing the required parameter 'run' when calling BlueOceanApi.get_pipeline_run_node_steps"
  end
  # verify the required parameter 'node' is set
  if @api_client.config.client_side_validation && node.nil?
    fail ArgumentError, "Missing the required parameter 'node' when calling BlueOceanApi.get_pipeline_run_node_steps"
  end
  # resource path
  local_var_path = "/blue/rest/organizations/{organization}/pipelines/{pipeline}/runs/{run}/nodes/{node}/steps".sub('{' + 'organization' + '}', organization.to_s).sub('{' + 'pipeline' + '}', pipeline.to_s).sub('{' + 'run' + '}', run.to_s).sub('{' + 'node' + '}', node.to_s)

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['jenkins_auth']
  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 => 'PipelineRunNodeSteps')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BlueOceanApi#get_pipeline_run_node_steps\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_pipeline_run_node_with_http_info(organization, pipeline, run, node, opts = {}) click to toggle source

Retrieve run node details for an organization pipeline @param organization Name of the organization @param pipeline Name of the pipeline @param run Name of the run @param node Name of the node @param [Hash] opts the optional parameters @return [Array<(PipelineRunNode, Fixnum, Hash)>] PipelineRunNode data, response status code and response headers

# File lib/swaggy_jenkins/api/blue_ocean_api.rb, line 946
def get_pipeline_run_node_with_http_info(organization, pipeline, run, node, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: BlueOceanApi.get_pipeline_run_node ..."
  end
  # verify the required parameter 'organization' is set
  if @api_client.config.client_side_validation && organization.nil?
    fail ArgumentError, "Missing the required parameter 'organization' when calling BlueOceanApi.get_pipeline_run_node"
  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 BlueOceanApi.get_pipeline_run_node"
  end
  # verify the required parameter 'run' is set
  if @api_client.config.client_side_validation && run.nil?
    fail ArgumentError, "Missing the required parameter 'run' when calling BlueOceanApi.get_pipeline_run_node"
  end
  # verify the required parameter 'node' is set
  if @api_client.config.client_side_validation && node.nil?
    fail ArgumentError, "Missing the required parameter 'node' when calling BlueOceanApi.get_pipeline_run_node"
  end
  # resource path
  local_var_path = "/blue/rest/organizations/{organization}/pipelines/{pipeline}/runs/{run}/nodes/{node}".sub('{' + 'organization' + '}', organization.to_s).sub('{' + 'pipeline' + '}', pipeline.to_s).sub('{' + 'run' + '}', run.to_s).sub('{' + 'node' + '}', node.to_s)

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['jenkins_auth']
  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 => 'PipelineRunNode')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BlueOceanApi#get_pipeline_run_node\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_pipeline_run_nodes(organization, pipeline, run, opts = {}) click to toggle source

Retrieve run nodes details for an organization pipeline @param organization Name of the organization @param pipeline Name of the pipeline @param run Name of the run @param [Hash] opts the optional parameters @return [PipelineRunNodes]

# File lib/swaggy_jenkins/api/blue_ocean_api.rb, line 1228
def get_pipeline_run_nodes(organization, pipeline, run, opts = {})
  data, _status_code, _headers = get_pipeline_run_nodes_with_http_info(organization, pipeline, run, opts)
  return data
end
get_pipeline_run_nodes_with_http_info(organization, pipeline, run, opts = {}) click to toggle source

Retrieve run nodes details for an organization pipeline @param organization Name of the organization @param pipeline Name of the pipeline @param run Name of the run @param [Hash] opts the optional parameters @return [Array<(PipelineRunNodes, Fixnum, Hash)>] PipelineRunNodes data, response status code and response headers

# File lib/swaggy_jenkins/api/blue_ocean_api.rb, line 1240
def get_pipeline_run_nodes_with_http_info(organization, pipeline, run, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: BlueOceanApi.get_pipeline_run_nodes ..."
  end
  # verify the required parameter 'organization' is set
  if @api_client.config.client_side_validation && organization.nil?
    fail ArgumentError, "Missing the required parameter 'organization' when calling BlueOceanApi.get_pipeline_run_nodes"
  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 BlueOceanApi.get_pipeline_run_nodes"
  end
  # verify the required parameter 'run' is set
  if @api_client.config.client_side_validation && run.nil?
    fail ArgumentError, "Missing the required parameter 'run' when calling BlueOceanApi.get_pipeline_run_nodes"
  end
  # resource path
  local_var_path = "/blue/rest/organizations/{organization}/pipelines/{pipeline}/runs/{run}/nodes".sub('{' + 'organization' + '}', organization.to_s).sub('{' + 'pipeline' + '}', pipeline.to_s).sub('{' + 'run' + '}', run.to_s)

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['jenkins_auth']
  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 => 'PipelineRunNodes')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BlueOceanApi#get_pipeline_run_nodes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_pipeline_run_with_http_info(organization, pipeline, run, opts = {}) click to toggle source

Retrieve run details for an organization pipeline @param organization Name of the organization @param pipeline Name of the pipeline @param run Name of the run @param [Hash] opts the optional parameters @return [Array<(PipelineRun, Fixnum, Hash)>] PipelineRun data, response status code and response headers

# File lib/swaggy_jenkins/api/blue_ocean_api.rb, line 808
def get_pipeline_run_with_http_info(organization, pipeline, run, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: BlueOceanApi.get_pipeline_run ..."
  end
  # verify the required parameter 'organization' is set
  if @api_client.config.client_side_validation && organization.nil?
    fail ArgumentError, "Missing the required parameter 'organization' when calling BlueOceanApi.get_pipeline_run"
  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 BlueOceanApi.get_pipeline_run"
  end
  # verify the required parameter 'run' is set
  if @api_client.config.client_side_validation && run.nil?
    fail ArgumentError, "Missing the required parameter 'run' when calling BlueOceanApi.get_pipeline_run"
  end
  # resource path
  local_var_path = "/blue/rest/organizations/{organization}/pipelines/{pipeline}/runs/{run}".sub('{' + 'organization' + '}', organization.to_s).sub('{' + 'pipeline' + '}', pipeline.to_s).sub('{' + 'run' + '}', run.to_s)

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['jenkins_auth']
  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 => 'PipelineRun')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BlueOceanApi#get_pipeline_run\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_pipeline_runs(organization, pipeline, opts = {}) click to toggle source

Retrieve all runs details for an organization pipeline @param organization Name of the organization @param pipeline Name of the pipeline @param [Hash] opts the optional parameters @return [PipelineRuns]

# File lib/swaggy_jenkins/api/blue_ocean_api.rb, line 1292
def get_pipeline_runs(organization, pipeline, opts = {})
  data, _status_code, _headers = get_pipeline_runs_with_http_info(organization, pipeline, opts)
  return data
end
get_pipeline_runs_with_http_info(organization, pipeline, opts = {}) click to toggle source

Retrieve all runs details for an organization pipeline @param organization Name of the organization @param pipeline Name of the pipeline @param [Hash] opts the optional parameters @return [Array<(PipelineRuns, Fixnum, Hash)>] PipelineRuns data, response status code and response headers

# File lib/swaggy_jenkins/api/blue_ocean_api.rb, line 1303
def get_pipeline_runs_with_http_info(organization, pipeline, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: BlueOceanApi.get_pipeline_runs ..."
  end
  # verify the required parameter 'organization' is set
  if @api_client.config.client_side_validation && organization.nil?
    fail ArgumentError, "Missing the required parameter 'organization' when calling BlueOceanApi.get_pipeline_runs"
  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 BlueOceanApi.get_pipeline_runs"
  end
  # resource path
  local_var_path = "/blue/rest/organizations/{organization}/pipelines/{pipeline}/runs".sub('{' + 'organization' + '}', organization.to_s).sub('{' + 'pipeline' + '}', pipeline.to_s)

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['jenkins_auth']
  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 => 'PipelineRuns')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BlueOceanApi#get_pipeline_runs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_pipeline_with_http_info(organization, pipeline, opts = {}) click to toggle source

Retrieve pipeline details for an organization @param organization Name of the organization @param pipeline Name of the pipeline @param [Hash] opts the optional parameters @return [Array<(Pipeline, Fixnum, Hash)>] Pipeline data, response status code and response headers

# File lib/swaggy_jenkins/api/blue_ocean_api.rb, line 310
def get_pipeline_with_http_info(organization, pipeline, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: BlueOceanApi.get_pipeline ..."
  end
  # verify the required parameter 'organization' is set
  if @api_client.config.client_side_validation && organization.nil?
    fail ArgumentError, "Missing the required parameter 'organization' when calling BlueOceanApi.get_pipeline"
  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 BlueOceanApi.get_pipeline"
  end
  # resource path
  local_var_path = "/blue/rest/organizations/{organization}/pipelines/{pipeline}".sub('{' + 'organization' + '}', organization.to_s).sub('{' + 'pipeline' + '}', pipeline.to_s)

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['jenkins_auth']
  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 => 'Pipeline')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BlueOceanApi#get_pipeline\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_pipelines(organization, opts = {}) click to toggle source

Retrieve all pipelines details for an organization @param organization Name of the organization @param [Hash] opts the optional parameters @return [Pipelines]

# File lib/swaggy_jenkins/api/blue_ocean_api.rb, line 1350
def get_pipelines(organization, opts = {})
  data, _status_code, _headers = get_pipelines_with_http_info(organization, opts)
  return data
end
get_pipelines_with_http_info(organization, opts = {}) click to toggle source

Retrieve all pipelines details for an organization @param organization Name of the organization @param [Hash] opts the optional parameters @return [Array<(Pipelines, Fixnum, Hash)>] Pipelines data, response status code and response headers

# File lib/swaggy_jenkins/api/blue_ocean_api.rb, line 1360
def get_pipelines_with_http_info(organization, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: BlueOceanApi.get_pipelines ..."
  end
  # verify the required parameter 'organization' is set
  if @api_client.config.client_side_validation && organization.nil?
    fail ArgumentError, "Missing the required parameter 'organization' when calling BlueOceanApi.get_pipelines"
  end
  # resource path
  local_var_path = "/blue/rest/organizations/{organization}/pipelines/".sub('{' + 'organization' + '}', organization.to_s)

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['jenkins_auth']
  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 => 'Pipelines')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BlueOceanApi#get_pipelines\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_scm(organization, scm, opts = {}) click to toggle source

Retrieve SCM details for an organization @param organization Name of the organization @param scm Name of SCM @param [Hash] opts the optional parameters @return [GithubScm]

# File lib/swaggy_jenkins/api/blue_ocean_api.rb, line 1404
def get_scm(organization, scm, opts = {})
  data, _status_code, _headers = get_scm_with_http_info(organization, scm, opts)
  return data
end
get_scm_organisation_repositories(organization, scm, scm_organisation, opts = {}) click to toggle source

Retrieve SCM organization repositories details for an organization @param organization Name of the organization @param scm Name of SCM @param scm_organisation Name of the SCM organization @param [Hash] opts the optional parameters @option opts [String] :credential_id Credential ID @option opts [Integer] :page_size Number of items in a page @option opts [Integer] :page_number Page number @return [ScmOrganisations]

# File lib/swaggy_jenkins/api/blue_ocean_api.rb, line 1467
def get_scm_organisation_repositories(organization, scm, scm_organisation, opts = {})
  data, _status_code, _headers = get_scm_organisation_repositories_with_http_info(organization, scm, scm_organisation, opts)
  return data
end
get_scm_organisation_repositories_with_http_info(organization, scm, scm_organisation, opts = {}) click to toggle source

Retrieve SCM organization repositories details for an organization @param organization Name of the organization @param scm Name of SCM @param scm_organisation Name of the SCM organization @param [Hash] opts the optional parameters @option opts [String] :credential_id Credential ID @option opts [Integer] :page_size Number of items in a page @option opts [Integer] :page_number Page number @return [Array<(ScmOrganisations, Fixnum, Hash)>] ScmOrganisations data, response status code and response headers

# File lib/swaggy_jenkins/api/blue_ocean_api.rb, line 1482
def get_scm_organisation_repositories_with_http_info(organization, scm, scm_organisation, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: BlueOceanApi.get_scm_organisation_repositories ..."
  end
  # verify the required parameter 'organization' is set
  if @api_client.config.client_side_validation && organization.nil?
    fail ArgumentError, "Missing the required parameter 'organization' when calling BlueOceanApi.get_scm_organisation_repositories"
  end
  # verify the required parameter 'scm' is set
  if @api_client.config.client_side_validation && scm.nil?
    fail ArgumentError, "Missing the required parameter 'scm' when calling BlueOceanApi.get_scm_organisation_repositories"
  end
  # verify the required parameter 'scm_organisation' is set
  if @api_client.config.client_side_validation && scm_organisation.nil?
    fail ArgumentError, "Missing the required parameter 'scm_organisation' when calling BlueOceanApi.get_scm_organisation_repositories"
  end
  # resource path
  local_var_path = "/blue/rest/organizations/{organization}/scm/{scm}/organizations/{scmOrganisation}/repositories".sub('{' + 'organization' + '}', organization.to_s).sub('{' + 'scm' + '}', scm.to_s).sub('{' + 'scmOrganisation' + '}', scm_organisation.to_s)

  # query parameters
  query_params = {}
  query_params[:'credentialId'] = opts[:'credential_id'] if !opts[:'credential_id'].nil?
  query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'pageNumber'] = opts[:'page_number'] if !opts[:'page_number'].nil?

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['jenkins_auth']
  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 => 'ScmOrganisations')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BlueOceanApi#get_scm_organisation_repositories\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_scm_organisation_repository(organization, scm, scm_organisation, repository, opts = {}) click to toggle source

Retrieve SCM organization repository details for an organization @param organization Name of the organization @param scm Name of SCM @param scm_organisation Name of the SCM organization @param repository Name of the SCM repository @param [Hash] opts the optional parameters @option opts [String] :credential_id Credential ID @return [ScmOrganisations]

# File lib/swaggy_jenkins/api/blue_ocean_api.rb, line 1540
def get_scm_organisation_repository(organization, scm, scm_organisation, repository, opts = {})
  data, _status_code, _headers = get_scm_organisation_repository_with_http_info(organization, scm, scm_organisation, repository, opts)
  return data
end
get_scm_organisation_repository_with_http_info(organization, scm, scm_organisation, repository, opts = {}) click to toggle source

Retrieve SCM organization repository details for an organization @param organization Name of the organization @param scm Name of SCM @param scm_organisation Name of the SCM organization @param repository Name of the SCM repository @param [Hash] opts the optional parameters @option opts [String] :credential_id Credential ID @return [Array<(ScmOrganisations, Fixnum, Hash)>] ScmOrganisations data, response status code and response headers

# File lib/swaggy_jenkins/api/blue_ocean_api.rb, line 1554
def get_scm_organisation_repository_with_http_info(organization, scm, scm_organisation, repository, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: BlueOceanApi.get_scm_organisation_repository ..."
  end
  # verify the required parameter 'organization' is set
  if @api_client.config.client_side_validation && organization.nil?
    fail ArgumentError, "Missing the required parameter 'organization' when calling BlueOceanApi.get_scm_organisation_repository"
  end
  # verify the required parameter 'scm' is set
  if @api_client.config.client_side_validation && scm.nil?
    fail ArgumentError, "Missing the required parameter 'scm' when calling BlueOceanApi.get_scm_organisation_repository"
  end
  # verify the required parameter 'scm_organisation' is set
  if @api_client.config.client_side_validation && scm_organisation.nil?
    fail ArgumentError, "Missing the required parameter 'scm_organisation' when calling BlueOceanApi.get_scm_organisation_repository"
  end
  # verify the required parameter 'repository' is set
  if @api_client.config.client_side_validation && repository.nil?
    fail ArgumentError, "Missing the required parameter 'repository' when calling BlueOceanApi.get_scm_organisation_repository"
  end
  # resource path
  local_var_path = "/blue/rest/organizations/{organization}/scm/{scm}/organizations/{scmOrganisation}/repositories/{repository}".sub('{' + 'organization' + '}', organization.to_s).sub('{' + 'scm' + '}', scm.to_s).sub('{' + 'scmOrganisation' + '}', scm_organisation.to_s).sub('{' + 'repository' + '}', repository.to_s)

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['jenkins_auth']
  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 => 'ScmOrganisations')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BlueOceanApi#get_scm_organisation_repository\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_scm_organisations(organization, scm, opts = {}) click to toggle source

Retrieve SCM organizations details for an organization @param organization Name of the organization @param scm Name of SCM @param [Hash] opts the optional parameters @option opts [String] :credential_id Credential ID @return [ScmOrganisations]

# File lib/swaggy_jenkins/api/blue_ocean_api.rb, line 1612
def get_scm_organisations(organization, scm, opts = {})
  data, _status_code, _headers = get_scm_organisations_with_http_info(organization, scm, opts)
  return data
end
get_scm_organisations_with_http_info(organization, scm, opts = {}) click to toggle source

Retrieve SCM organizations details for an organization @param organization Name of the organization @param scm Name of SCM @param [Hash] opts the optional parameters @option opts [String] :credential_id Credential ID @return [Array<(ScmOrganisations, Fixnum, Hash)>] ScmOrganisations data, response status code and response headers

# File lib/swaggy_jenkins/api/blue_ocean_api.rb, line 1624
def get_scm_organisations_with_http_info(organization, scm, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: BlueOceanApi.get_scm_organisations ..."
  end
  # verify the required parameter 'organization' is set
  if @api_client.config.client_side_validation && organization.nil?
    fail ArgumentError, "Missing the required parameter 'organization' when calling BlueOceanApi.get_scm_organisations"
  end
  # verify the required parameter 'scm' is set
  if @api_client.config.client_side_validation && scm.nil?
    fail ArgumentError, "Missing the required parameter 'scm' when calling BlueOceanApi.get_scm_organisations"
  end
  # resource path
  local_var_path = "/blue/rest/organizations/{organization}/scm/{scm}/organizations".sub('{' + 'organization' + '}', organization.to_s).sub('{' + 'scm' + '}', scm.to_s)

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['jenkins_auth']
  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 => 'ScmOrganisations')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BlueOceanApi#get_scm_organisations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_scm_with_http_info(organization, scm, opts = {}) click to toggle source

Retrieve SCM details for an organization @param organization Name of the organization @param scm Name of SCM @param [Hash] opts the optional parameters @return [Array<(GithubScm, Fixnum, Hash)>] GithubScm data, response status code and response headers

# File lib/swaggy_jenkins/api/blue_ocean_api.rb, line 1415
def get_scm_with_http_info(organization, scm, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: BlueOceanApi.get_scm ..."
  end
  # verify the required parameter 'organization' is set
  if @api_client.config.client_side_validation && organization.nil?
    fail ArgumentError, "Missing the required parameter 'organization' when calling BlueOceanApi.get_scm"
  end
  # verify the required parameter 'scm' is set
  if @api_client.config.client_side_validation && scm.nil?
    fail ArgumentError, "Missing the required parameter 'scm' when calling BlueOceanApi.get_scm"
  end
  # resource path
  local_var_path = "/blue/rest/organizations/{organization}/scm/{scm}".sub('{' + 'organization' + '}', organization.to_s).sub('{' + 'scm' + '}', scm.to_s)

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['jenkins_auth']
  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 => 'GithubScm')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BlueOceanApi#get_scm\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_user(organization, user, opts = {}) click to toggle source

Retrieve user details for an organization @param organization Name of the organization @param user Name of the user @param [Hash] opts the optional parameters @return [User]

# File lib/swaggy_jenkins/api/blue_ocean_api.rb, line 1673
def get_user(organization, user, opts = {})
  data, _status_code, _headers = get_user_with_http_info(organization, user, opts)
  return data
end
get_user_favorites(user, opts = {}) click to toggle source

Retrieve user favorites details for an organization @param user Name of the user @param [Hash] opts the optional parameters @return [UserFavorites]

# File lib/swaggy_jenkins/api/blue_ocean_api.rb, line 1731
def get_user_favorites(user, opts = {})
  data, _status_code, _headers = get_user_favorites_with_http_info(user, opts)
  return data
end
get_user_favorites_with_http_info(user, opts = {}) click to toggle source

Retrieve user favorites details for an organization @param user Name of the user @param [Hash] opts the optional parameters @return [Array<(UserFavorites, Fixnum, Hash)>] UserFavorites data, response status code and response headers

# File lib/swaggy_jenkins/api/blue_ocean_api.rb, line 1741
def get_user_favorites_with_http_info(user, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: BlueOceanApi.get_user_favorites ..."
  end
  # verify the required parameter 'user' is set
  if @api_client.config.client_side_validation && user.nil?
    fail ArgumentError, "Missing the required parameter 'user' when calling BlueOceanApi.get_user_favorites"
  end
  # resource path
  local_var_path = "/blue/rest/users/{user}/favorites".sub('{' + 'user' + '}', user.to_s)

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['jenkins_auth']
  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 => 'UserFavorites')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BlueOceanApi#get_user_favorites\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_user_with_http_info(organization, user, opts = {}) click to toggle source

Retrieve user details for an organization @param organization Name of the organization @param user Name of the user @param [Hash] opts the optional parameters @return [Array<(User, Fixnum, Hash)>] User data, response status code and response headers

# File lib/swaggy_jenkins/api/blue_ocean_api.rb, line 1684
def get_user_with_http_info(organization, user, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: BlueOceanApi.get_user ..."
  end
  # verify the required parameter 'organization' is set
  if @api_client.config.client_side_validation && organization.nil?
    fail ArgumentError, "Missing the required parameter 'organization' when calling BlueOceanApi.get_user"
  end
  # verify the required parameter 'user' is set
  if @api_client.config.client_side_validation && user.nil?
    fail ArgumentError, "Missing the required parameter 'user' when calling BlueOceanApi.get_user"
  end
  # resource path
  local_var_path = "/blue/rest/organizations/{organization}/users/{user}".sub('{' + 'organization' + '}', organization.to_s).sub('{' + 'user' + '}', user.to_s)

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['jenkins_auth']
  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 => 'User')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BlueOceanApi#get_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_users(organization, opts = {}) click to toggle source

Retrieve users details for an organization @param organization Name of the organization @param [Hash] opts the optional parameters @return [User]

# File lib/swaggy_jenkins/api/blue_ocean_api.rb, line 1784
def get_users(organization, opts = {})
  data, _status_code, _headers = get_users_with_http_info(organization, opts)
  return data
end
get_users_with_http_info(organization, opts = {}) click to toggle source

Retrieve users details for an organization @param organization Name of the organization @param [Hash] opts the optional parameters @return [Array<(User, Fixnum, Hash)>] User data, response status code and response headers

# File lib/swaggy_jenkins/api/blue_ocean_api.rb, line 1794
def get_users_with_http_info(organization, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: BlueOceanApi.get_users ..."
  end
  # verify the required parameter 'organization' is set
  if @api_client.config.client_side_validation && organization.nil?
    fail ArgumentError, "Missing the required parameter 'organization' when calling BlueOceanApi.get_users"
  end
  # resource path
  local_var_path = "/blue/rest/organizations/{organization}/users/".sub('{' + 'organization' + '}', organization.to_s)

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['jenkins_auth']
  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 => 'User')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BlueOceanApi#get_users\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
post_pipeline_run(organization, pipeline, run, opts = {}) click to toggle source

Replay an organization pipeline run @param organization Name of the organization @param pipeline Name of the pipeline @param run Name of the run @param [Hash] opts the optional parameters @return [QueueItemImpl]

# File lib/swaggy_jenkins/api/blue_ocean_api.rb, line 1839
def post_pipeline_run(organization, pipeline, run, opts = {})
  data, _status_code, _headers = post_pipeline_run_with_http_info(organization, pipeline, run, opts)
  return data
end
post_pipeline_run_with_http_info(organization, pipeline, run, opts = {}) click to toggle source

Replay an organization pipeline run @param organization Name of the organization @param pipeline Name of the pipeline @param run Name of the run @param [Hash] opts the optional parameters @return [Array<(QueueItemImpl, Fixnum, Hash)>] QueueItemImpl data, response status code and response headers

# File lib/swaggy_jenkins/api/blue_ocean_api.rb, line 1851
def post_pipeline_run_with_http_info(organization, pipeline, run, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: BlueOceanApi.post_pipeline_run ..."
  end
  # verify the required parameter 'organization' is set
  if @api_client.config.client_side_validation && organization.nil?
    fail ArgumentError, "Missing the required parameter 'organization' when calling BlueOceanApi.post_pipeline_run"
  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 BlueOceanApi.post_pipeline_run"
  end
  # verify the required parameter 'run' is set
  if @api_client.config.client_side_validation && run.nil?
    fail ArgumentError, "Missing the required parameter 'run' when calling BlueOceanApi.post_pipeline_run"
  end
  # resource path
  local_var_path = "/blue/rest/organizations/{organization}/pipelines/{pipeline}/runs/{run}/replay".sub('{' + 'organization' + '}', organization.to_s).sub('{' + 'pipeline' + '}', pipeline.to_s).sub('{' + 'run' + '}', run.to_s)

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['jenkins_auth']
  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 => 'QueueItemImpl')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BlueOceanApi#post_pipeline_run\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
post_pipeline_runs(organization, pipeline, opts = {}) click to toggle source

Start a build for an organization pipeline @param organization Name of the organization @param pipeline Name of the pipeline @param [Hash] opts the optional parameters @return [QueueItemImpl]

# File lib/swaggy_jenkins/api/blue_ocean_api.rb, line 1903
def post_pipeline_runs(organization, pipeline, opts = {})
  data, _status_code, _headers = post_pipeline_runs_with_http_info(organization, pipeline, opts)
  return data
end
post_pipeline_runs_with_http_info(organization, pipeline, opts = {}) click to toggle source

Start a build for an organization pipeline @param organization Name of the organization @param pipeline Name of the pipeline @param [Hash] opts the optional parameters @return [Array<(QueueItemImpl, Fixnum, Hash)>] QueueItemImpl data, response status code and response headers

# File lib/swaggy_jenkins/api/blue_ocean_api.rb, line 1914
def post_pipeline_runs_with_http_info(organization, pipeline, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: BlueOceanApi.post_pipeline_runs ..."
  end
  # verify the required parameter 'organization' is set
  if @api_client.config.client_side_validation && organization.nil?
    fail ArgumentError, "Missing the required parameter 'organization' when calling BlueOceanApi.post_pipeline_runs"
  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 BlueOceanApi.post_pipeline_runs"
  end
  # resource path
  local_var_path = "/blue/rest/organizations/{organization}/pipelines/{pipeline}/runs".sub('{' + 'organization' + '}', organization.to_s).sub('{' + 'pipeline' + '}', pipeline.to_s)

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['jenkins_auth']
  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 => 'QueueItemImpl')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BlueOceanApi#post_pipeline_runs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
put_pipeline_favorite(organization, pipeline, body, opts = {}) click to toggle source

Favorite/unfavorite a pipeline @param organization Name of the organization @param pipeline Name of the pipeline @param body Set JSON string body to {&quot;favorite&quot;: true} to favorite, set value to false to unfavorite @param [Hash] opts the optional parameters @return [FavoriteImpl]

# File lib/swaggy_jenkins/api/blue_ocean_api.rb, line 1963
def put_pipeline_favorite(organization, pipeline, body, opts = {})
  data, _status_code, _headers = put_pipeline_favorite_with_http_info(organization, pipeline, body, opts)
  return data
end
put_pipeline_favorite_with_http_info(organization, pipeline, body, opts = {}) click to toggle source

Favorite/unfavorite a pipeline @param organization Name of the organization @param pipeline Name of the pipeline @param body Set JSON string body to {&quot;favorite&quot;: true} to favorite, set value to false to unfavorite @param [Hash] opts the optional parameters @return [Array<(FavoriteImpl, Fixnum, Hash)>] FavoriteImpl data, response status code and response headers

# File lib/swaggy_jenkins/api/blue_ocean_api.rb, line 1975
def put_pipeline_favorite_with_http_info(organization, pipeline, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: BlueOceanApi.put_pipeline_favorite ..."
  end
  # verify the required parameter 'organization' is set
  if @api_client.config.client_side_validation && organization.nil?
    fail ArgumentError, "Missing the required parameter 'organization' when calling BlueOceanApi.put_pipeline_favorite"
  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 BlueOceanApi.put_pipeline_favorite"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling BlueOceanApi.put_pipeline_favorite"
  end
  # resource path
  local_var_path = "/blue/rest/organizations/{organization}/pipelines/{pipeline}/favorite".sub('{' + 'organization' + '}', organization.to_s).sub('{' + 'pipeline' + '}', pipeline.to_s)

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  auth_names = ['jenkins_auth']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'FavoriteImpl')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BlueOceanApi#put_pipeline_favorite\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
put_pipeline_run(organization, pipeline, run, opts = {}) click to toggle source

Stop a build of an organization pipeline @param organization Name of the organization @param pipeline Name of the pipeline @param run Name of the run @param [Hash] opts the optional parameters @option opts [String] :blocking Set to true to make blocking stop, default: false @option opts [Integer] :time_out_in_secs Timeout in seconds, default: 10 seconds @return [PipelineRun]

# File lib/swaggy_jenkins/api/blue_ocean_api.rb, line 2030
def put_pipeline_run(organization, pipeline, run, opts = {})
  data, _status_code, _headers = put_pipeline_run_with_http_info(organization, pipeline, run, opts)
  return data
end
put_pipeline_run_with_http_info(organization, pipeline, run, opts = {}) click to toggle source

Stop a build of an organization pipeline @param organization Name of the organization @param pipeline Name of the pipeline @param run Name of the run @param [Hash] opts the optional parameters @option opts [String] :blocking Set to true to make blocking stop, default: false @option opts [Integer] :time_out_in_secs Timeout in seconds, default: 10 seconds @return [Array<(PipelineRun, Fixnum, Hash)>] PipelineRun data, response status code and response headers

# File lib/swaggy_jenkins/api/blue_ocean_api.rb, line 2044
def put_pipeline_run_with_http_info(organization, pipeline, run, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: BlueOceanApi.put_pipeline_run ..."
  end
  # verify the required parameter 'organization' is set
  if @api_client.config.client_side_validation && organization.nil?
    fail ArgumentError, "Missing the required parameter 'organization' when calling BlueOceanApi.put_pipeline_run"
  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 BlueOceanApi.put_pipeline_run"
  end
  # verify the required parameter 'run' is set
  if @api_client.config.client_side_validation && run.nil?
    fail ArgumentError, "Missing the required parameter 'run' when calling BlueOceanApi.put_pipeline_run"
  end
  # resource path
  local_var_path = "/blue/rest/organizations/{organization}/pipelines/{pipeline}/runs/{run}/stop".sub('{' + 'organization' + '}', organization.to_s).sub('{' + 'pipeline' + '}', pipeline.to_s).sub('{' + 'run' + '}', run.to_s)

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['jenkins_auth']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'PipelineRun')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BlueOceanApi#put_pipeline_run\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
search_classes(q, opts = {}) click to toggle source

Get classes details @param q Query string containing an array of class names @param [Hash] opts the optional parameters @return [String]

# File lib/swaggy_jenkins/api/blue_ocean_api.rb, line 2151
def search_classes(q, opts = {})
  data, _status_code, _headers = search_classes_with_http_info(q, opts)
  return data
end
search_classes_with_http_info(q, opts = {}) click to toggle source

Get classes details @param q Query string containing an array of class names @param [Hash] opts the optional parameters @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers

# File lib/swaggy_jenkins/api/blue_ocean_api.rb, line 2161
def search_classes_with_http_info(q, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: BlueOceanApi.search_classes ..."
  end
  # verify the required parameter 'q' is set
  if @api_client.config.client_side_validation && q.nil?
    fail ArgumentError, "Missing the required parameter 'q' when calling BlueOceanApi.search_classes"
  end
  # resource path
  local_var_path = "/blue/rest/classes/"

  # query parameters
  query_params = {}
  query_params[:'q'] = q

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['jenkins_auth']
  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 => 'String')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BlueOceanApi#search_classes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
search_with_http_info(q, opts = {}) click to toggle source

Search for any resource details @param q Query string @param [Hash] opts the optional parameters @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers

# File lib/swaggy_jenkins/api/blue_ocean_api.rb, line 2107
def search_with_http_info(q, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: BlueOceanApi.search ..."
  end
  # verify the required parameter 'q' is set
  if @api_client.config.client_side_validation && q.nil?
    fail ArgumentError, "Missing the required parameter 'q' when calling BlueOceanApi.search"
  end
  # resource path
  local_var_path = "/blue/rest/search/"

  # query parameters
  query_params = {}
  query_params[:'q'] = q

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['jenkins_auth']
  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 => 'String')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BlueOceanApi#search\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end