clients/ruby/generated/lib/swaggy_jenkins/api/blue_ocean_api.rb
# Stop a build of an organization pipeline
# @param organization [String] Name of the organization
# @param pipeline [String] Name of the pipeline
# @param run [String] 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, Integer, Hash)>] PipelineRun data, response status code and response headers
Stop a build of an organization pipeline
Stop a build of an organization pipeline
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
      if @api_client.config.client_side_validation && organization.nil?
        fail ArgumentError, "Missing the required parameter 'organization' when calling BlueOceanApi.put_pipeline_run"
      end
      if @api_client.config.client_side_validation && pipeline.nil?
        fail ArgumentError, "Missing the required parameter 'pipeline' when calling BlueOceanApi.put_pipeline_run"
      end
      if @api_client.config.client_side_validation && run.nil?
        fail ArgumentError, "Missing the required parameter 'run' when calling BlueOceanApi.put_pipeline_run"
      end
      local_var_path = '/blue/rest/organizations/{organization}/pipelines/{pipeline}/runs/{run}/stop'.sub('{' + 'organization' + '}', CGI.escape(organization.to_s)).sub('{' + 'pipeline' + '}', CGI.escape(pipeline.to_s)).sub('{' + 'run' + '}', CGI.escape(run.to_s))
      query_params = opts[: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_params = opts[:header_params] || {}
      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
      form_params = opts[:form_params] || {}
      post_body = opts[:debug_body]
      return_type = opts[:debug_return_type] || 'PipelineRun'
      auth_names = opts[:debug_auth_names] || ['jenkins_auth']
      new_options = opts.merge(
        :operation => :"BlueOceanApi.put_pipeline_run",
        :header_params => header_params,
        :query_params => query_params,
        :form_params => form_params,
        :body => post_body,
        :auth_names => auth_names,
        :return_type => return_type
      )
      data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
      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
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 if @api_client . config . client_side_validation && organization . nil? fail ArgumentError , "Missing the required parameter 'organization' when calling BlueOceanApi.put_pipeline_run" end if @api_client . config . client_side_validation && pipeline . nil? fail ArgumentError , "Missing the required parameter 'pipeline' when calling BlueOceanApi.put_pipeline_run" end if @api_client . config . client_side_validation && run . nil? fail ArgumentError , "Missing the required parameter 'run' when calling BlueOceanApi.put_pipeline_run" end local_var_path = '/blue/rest/organizations/{organization}/pipelines/{pipeline}/runs/{run}/stop' . sub ( '{' + 'organization' + '}' , CGI . escape ( organization . to_s ) ) . sub ( '{' + 'pipeline' + '}' , CGI . escape ( pipeline . to_s ) ) . sub ( '{' + 'run' + '}' , CGI . escape ( run . to_s ) ) query_params = opts [ :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_params = opts [ :header_params ] || { } header_params [ 'Accept' ] = @api_client . select_header_accept ( [ 'application/json' ] ) form_params = opts [ :form_params ] || { } post_body = opts [ :debug_body ] return_type = opts [ :debug_return_type ] || 'PipelineRun' auth_names = opts [ :debug_auth_names ] || [ 'jenkins_auth' ] new_options = opts . merge ( :operation => :" BlueOceanApi.put_pipeline_run " , :header_params => header_params , :query_params => query_params , :form_params => form_params , :body => post_body , :auth_names => auth_names , :return_type => return_type ) data , status_code , headers = @api_client . call_api ( :PUT , local_var_path , new_options ) 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
Stop a build of an organization pipeline
Stop a build of an organization pipeline
# verify the required parameter 'organization' is set # verify the required parameter 'pipeline' is set # verify the required parameter 'run' is set # resource path # query parameters # header parameters # HTTP header 'Accept' (if needed) # form parameters # http body (model) # return_type # auth_names
PipelineRun data, response status code and response headers
PipelineRun data response status code and response headers
Array<(PipelineRun, Integer, Hash)>
organization
Name of the organization
Name of the organization
pipeline
Name of the pipeline
Name of the pipeline
run
Name of the run
Name of the run
opts
:time_out_in_secs Timeout in seconds, default: 10 seconds
: time_out_in_secs Timeout in seconds default : 10 seconds
opts the optional parameters
opts the optional parameters