Class: SwaggyJenkinsClient::BlueOceanApi

Inherits:
Object
  • Object
show all
Defined in:
lib/swaggy_jenkins/api/blue_ocean_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ BlueOceanApi

Returns a new instance of BlueOceanApi.



19
20
21
 
# File 'lib/swaggy_jenkins/api/blue_ocean_api.rb', line 19

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/swaggy_jenkins/api/blue_ocean_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#delete_pipeline_queue_item(organization, pipeline, queue, opts = {}) ⇒ nil

Delete queue item from an organization pipeline queue

Parameters:

  • organization (String) —

    Name of the organization

  • pipeline (String) —

    Name of the pipeline

  • queue (String) —

    Name of the queue item

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


28
29
30
31
 
# File 'lib/swaggy_jenkins/api/blue_ocean_api.rb', line 28

def delete_pipeline_queue_item(organization, pipeline, queue, opts = {})
  delete_pipeline_queue_item_with_http_info(organization, pipeline, queue, opts)
  nil
end

#delete_pipeline_queue_item_with_http_info(organization, pipeline, queue, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete queue item from an organization pipeline queue

Parameters:

  • organization (String) —

    Name of the organization

  • pipeline (String) —

    Name of the pipeline

  • queue (String) —

    Name of the queue item

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/swaggy_jenkins/api/blue_ocean_api.rb', line 39

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' + '}', CGI.escape(organization.to_s)).sub('{' + 'pipeline' + '}', CGI.escape(pipeline.to_s)).sub('{' + 'queue' + '}', CGI.escape(queue.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || ['jenkins_auth']

  new_options = opts.merge(
    :operation => :"BlueOceanApi.delete_pipeline_queue_item",
    :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(:DELETE, local_var_path, new_options)
  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 = {}) ⇒ User

Retrieve authenticated user details for an organization

Parameters:

  • organization (String) —

    Name of the organization

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



97
98
99
100
 
# File 'lib/swaggy_jenkins/api/blue_ocean_api.rb', line 97

def get_authenticated_user(organization, opts = {})
  data, _status_code, _headers = get_authenticated_user_with_http_info(organization, opts)
  data
end

#get_authenticated_user_with_http_info(organization, opts = {}) ⇒ Array<(User, Integer, Hash)>

Retrieve authenticated user details for an organization

Parameters:

  • organization (String) —

    Name of the organization

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(User, Integer, Hash)>) —

    User data, response status code and response headers



106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
 
# File 'lib/swaggy_jenkins/api/blue_ocean_api.rb', line 106

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' + '}', CGI.escape(organization.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

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

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'User'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['jenkins_auth']

  new_options = opts.merge(
    :operation => :"BlueOceanApi.get_authenticated_user",
    :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(:GET, local_var_path, new_options)
  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 = {}) ⇒ String

Get a list of class names supported by a given class

Parameters:

  • _class (String) —

    Name of the class

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (String) 


158
159
160
161
 
# File 'lib/swaggy_jenkins/api/blue_ocean_api.rb', line 158

def get_classes(_class, opts = {})
  data, _status_code, _headers = get_classes_with_http_info(_class, opts)
  data
end

#get_classes_with_http_info(_class, opts = {}) ⇒ Array<(String, Integer, Hash)>

Get a list of class names supported by a given class

Parameters:

  • _class (String) —

    Name of the class

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(String, Integer, Hash)>) —

    String data, response status code and response headers



167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
 
# File 'lib/swaggy_jenkins/api/blue_ocean_api.rb', line 167

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' + '}', CGI.escape(_class.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

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

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'String'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['jenkins_auth']

  new_options = opts.merge(
    :operation => :"BlueOceanApi.get_classes",
    :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(:GET, local_var_path, new_options)
  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_json_web_key(key, opts = {}) ⇒ String

Retrieve JSON Web Key

Parameters:

  • key (Integer) —

    Key ID received as part of JWT header field kid

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (String) 


219
220
221
222
 
# File 'lib/swaggy_jenkins/api/blue_ocean_api.rb', line 219

def get_json_web_key(key, opts = {})
  data, _status_code, _headers = get_json_web_key_with_http_info(key, opts)
  data
end

#get_json_web_key_with_http_info(key, opts = {}) ⇒ Array<(String, Integer, Hash)>

Retrieve JSON Web Key

Parameters:

  • key (Integer) —

    Key ID received as part of JWT header field kid

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(String, Integer, Hash)>) —

    String data, response status code and response headers



228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
 
# File 'lib/swaggy_jenkins/api/blue_ocean_api.rb', line 228

def get_json_web_key_with_http_info(key, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BlueOceanApi.get_json_web_key ...'
  end
  # verify the required parameter 'key' is set
  if @api_client.config.client_side_validation && key.nil?
    fail ArgumentError, "Missing the required parameter 'key' when calling BlueOceanApi.get_json_web_key"
  end
  # resource path
  local_var_path = '/jwt-auth/jwks/{key}'.sub('{' + 'key' + '}', CGI.escape(key.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

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

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'String'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"BlueOceanApi.get_json_web_key",
    :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(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BlueOceanApi#get_json_web_key\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_json_web_token(opts = {}) ⇒ String

Retrieve JSON Web Token

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :expiry_time_in_mins (Integer) —

    Token expiry time in minutes, default: 30 minutes

  • :max_expiry_time_in_mins (Integer) —

    Maximum token expiry time in minutes, default: 480 minutes

Returns:

  • (String) 


281
282
283
284
 
# File 'lib/swaggy_jenkins/api/blue_ocean_api.rb', line 281

def get_json_web_token(opts = {})
  data, _status_code, _headers = get_json_web_token_with_http_info(opts)
  data
end

#get_json_web_token_with_http_info(opts = {}) ⇒ Array<(String, Integer, Hash)>

Retrieve JSON Web Token

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :expiry_time_in_mins (Integer) —

    Token expiry time in minutes, default: 30 minutes

  • :max_expiry_time_in_mins (Integer) —

    Maximum token expiry time in minutes, default: 480 minutes

Returns:

  • (Array<(String, Integer, Hash)>) —

    String data, response status code and response headers



291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
 
# File 'lib/swaggy_jenkins/api/blue_ocean_api.rb', line 291

def get_json_web_token_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BlueOceanApi.get_json_web_token ...'
  end
  # resource path
  local_var_path = '/jwt-auth/token'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'expiryTimeInMins'] = opts[:'expiry_time_in_mins'] if !opts[:'expiry_time_in_mins'].nil?
  query_params[:'maxExpiryTimeInMins'] = opts[:'max_expiry_time_in_mins'] if !opts[:'max_expiry_time_in_mins'].nil?

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

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'String'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"BlueOceanApi.get_json_web_token",
    :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(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BlueOceanApi#get_json_web_token\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_organisation(organization, opts = {}) ⇒ Organisation

Retrieve organization details

Parameters:

  • organization (String) —

    Name of the organization

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



341
342
343
344
 
# File 'lib/swaggy_jenkins/api/blue_ocean_api.rb', line 341

def get_organisation(organization, opts = {})
  data, _status_code, _headers = get_organisation_with_http_info(organization, opts)
  data
end

#get_organisation_with_http_info(organization, opts = {}) ⇒ Array<(Organisation, Integer, Hash)>

Retrieve organization details

Parameters:

  • organization (String) —

    Name of the organization

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Organisation, Integer, Hash)>) —

    Organisation data, response status code and response headers



350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
 
# File 'lib/swaggy_jenkins/api/blue_ocean_api.rb', line 350

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' + '}', CGI.escape(organization.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

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

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Organisation'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['jenkins_auth']

  new_options = opts.merge(
    :operation => :"BlueOceanApi.get_organisation",
    :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(:GET, local_var_path, new_options)
  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 = {}) ⇒ Array<Organisation>

Retrieve all organizations details

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



401
402
403
404
 
# File 'lib/swaggy_jenkins/api/blue_ocean_api.rb', line 401

def get_organisations(opts = {})
  data, _status_code, _headers = get_organisations_with_http_info(opts)
  data
end

#get_organisations_with_http_info(opts = {}) ⇒ Array<(Array<Organisation>, Integer, Hash)>

Retrieve all organizations details

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Array<Organisation>, Integer, Hash)>) —

    Array<Organisation> data, response status code and response headers



409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
 
# File 'lib/swaggy_jenkins/api/blue_ocean_api.rb', line 409

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 = opts[:query_params] || {}

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

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Array<Organisation>'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['jenkins_auth']

  new_options = opts.merge(
    :operation => :"BlueOceanApi.get_organisations",
    :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(:GET, local_var_path, new_options)
  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 = {}) ⇒ Pipeline

Retrieve pipeline details for an organization

Parameters:

  • organization (String) —

    Name of the organization

  • pipeline (String) —

    Name of the pipeline

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



458
459
460
461
 
# File 'lib/swaggy_jenkins/api/blue_ocean_api.rb', line 458

def get_pipeline(organization, pipeline, opts = {})
  data, _status_code, _headers = get_pipeline_with_http_info(organization, pipeline, opts)
  data
end

#get_pipeline_activities(organization, pipeline, opts = {}) ⇒ Array<PipelineActivity>

Retrieve all activities details for an organization pipeline

Parameters:

  • organization (String) —

    Name of the organization

  • pipeline (String) —

    Name of the pipeline

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



525
526
527
528
 
# File 'lib/swaggy_jenkins/api/blue_ocean_api.rb', line 525

def get_pipeline_activities(organization, pipeline, opts = {})
  data, _status_code, _headers = get_pipeline_activities_with_http_info(organization, pipeline, opts)
  data
end

#get_pipeline_activities_with_http_info(organization, pipeline, opts = {}) ⇒ Array<(Array<PipelineActivity>, Integer, Hash)>

Retrieve all activities details for an organization pipeline

Parameters:

  • organization (String) —

    Name of the organization

  • pipeline (String) —

    Name of the pipeline

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Array<PipelineActivity>, Integer, Hash)>) —

    Array<PipelineActivity> data, response status code and response headers



535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
 
# File 'lib/swaggy_jenkins/api/blue_ocean_api.rb', line 535

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' + '}', CGI.escape(organization.to_s)).sub('{' + 'pipeline' + '}', CGI.escape(pipeline.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

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

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Array<PipelineActivity>'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['jenkins_auth']

  new_options = opts.merge(
    :operation => :"BlueOceanApi.get_pipeline_activities",
    :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(:GET, local_var_path, new_options)
  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 = {}) ⇒ BranchImpl

Retrieve branch details for an organization pipeline

Parameters:

  • organization (String) —

    Name of the organization

  • pipeline (String) —

    Name of the pipeline

  • branch (String) —

    Name of the branch

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



593
594
595
596
 
# File 'lib/swaggy_jenkins/api/blue_ocean_api.rb', line 593

def get_pipeline_branch(organization, pipeline, branch, opts = {})
  data, _status_code, _headers = get_pipeline_branch_with_http_info(organization, pipeline, branch, opts)
  data
end

#get_pipeline_branch_run(organization, pipeline, branch, run, opts = {}) ⇒ PipelineRun

Retrieve branch run details for an organization pipeline

Parameters:

  • organization (String) —

    Name of the organization

  • pipeline (String) —

    Name of the pipeline

  • branch (String) —

    Name of the branch

  • run (String) —

    Name of the run

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



667
668
669
670
 
# File 'lib/swaggy_jenkins/api/blue_ocean_api.rb', line 667

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)
  data
end

#get_pipeline_branch_run_with_http_info(organization, pipeline, branch, run, opts = {}) ⇒ Array<(PipelineRun, Integer, Hash)>

Retrieve branch run details for an organization pipeline

Parameters:

  • organization (String) —

    Name of the organization

  • pipeline (String) —

    Name of the pipeline

  • branch (String) —

    Name of the branch

  • run (String) —

    Name of the run

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(PipelineRun, Integer, Hash)>) —

    PipelineRun data, response status code and response headers



679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
 
# File 'lib/swaggy_jenkins/api/blue_ocean_api.rb', line 679

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' + '}', CGI.escape(organization.to_s)).sub('{' + 'pipeline' + '}', CGI.escape(pipeline.to_s)).sub('{' + 'branch' + '}', CGI.escape(branch.to_s)).sub('{' + 'run' + '}', CGI.escape(run.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

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

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'PipelineRun'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['jenkins_auth']

  new_options = opts.merge(
    :operation => :"BlueOceanApi.get_pipeline_branch_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(:GET, local_var_path, new_options)
  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 = {}) ⇒ Array<(BranchImpl, Integer, Hash)>

Retrieve branch details for an organization pipeline

Parameters:

  • organization (String) —

    Name of the organization

  • pipeline (String) —

    Name of the pipeline

  • branch (String) —

    Name of the branch

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(BranchImpl, Integer, Hash)>) —

    BranchImpl data, response status code and response headers



604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
 
# File 'lib/swaggy_jenkins/api/blue_ocean_api.rb', line 604

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' + '}', CGI.escape(organization.to_s)).sub('{' + 'pipeline' + '}', CGI.escape(pipeline.to_s)).sub('{' + 'branch' + '}', CGI.escape(branch.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

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

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'BranchImpl'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['jenkins_auth']

  new_options = opts.merge(
    :operation => :"BlueOceanApi.get_pipeline_branch",
    :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(:GET, local_var_path, new_options)
  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 = {}) ⇒ MultibranchPipeline

Retrieve all branches details for an organization pipeline

Parameters:

  • organization (String) —

    Name of the organization

  • pipeline (String) —

    Name of the pipeline

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



744
745
746
747
 
# File 'lib/swaggy_jenkins/api/blue_ocean_api.rb', line 744

def get_pipeline_branches(organization, pipeline, opts = {})
  data, _status_code, _headers = get_pipeline_branches_with_http_info(organization, pipeline, opts)
  data
end

#get_pipeline_branches_with_http_info(organization, pipeline, opts = {}) ⇒ Array<(MultibranchPipeline, Integer, Hash)>

Retrieve all branches details for an organization pipeline

Parameters:

  • organization (String) —

    Name of the organization

  • pipeline (String) —

    Name of the pipeline

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(MultibranchPipeline, Integer, Hash)>) —

    MultibranchPipeline data, response status code and response headers



754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
 
# File 'lib/swaggy_jenkins/api/blue_ocean_api.rb', line 754

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' + '}', CGI.escape(organization.to_s)).sub('{' + 'pipeline' + '}', CGI.escape(pipeline.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

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

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'MultibranchPipeline'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['jenkins_auth']

  new_options = opts.merge(
    :operation => :"BlueOceanApi.get_pipeline_branches",
    :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(:GET, local_var_path, new_options)
  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 = {}) ⇒ PipelineFolderImpl

Retrieve pipeline folder for an organization

Parameters:

  • organization (String) —

    Name of the organization

  • folder (String) —

    Name of the folder

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



811
812
813
814
 
# File 'lib/swaggy_jenkins/api/blue_ocean_api.rb', line 811

def get_pipeline_folder(organization, folder, opts = {})
  data, _status_code, _headers = get_pipeline_folder_with_http_info(organization, folder, opts)
  data
end

#get_pipeline_folder_pipeline(organization, pipeline, folder, opts = {}) ⇒ PipelineImpl

Retrieve pipeline details for an organization folder

Parameters:

  • organization (String) —

    Name of the organization

  • pipeline (String) —

    Name of the pipeline

  • folder (String) —

    Name of the folder

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



879
880
881
882
 
# File 'lib/swaggy_jenkins/api/blue_ocean_api.rb', line 879

def get_pipeline_folder_pipeline(organization, pipeline, folder, opts = {})
  data, _status_code, _headers = get_pipeline_folder_pipeline_with_http_info(organization, pipeline, folder, opts)
  data
end

#get_pipeline_folder_pipeline_with_http_info(organization, pipeline, folder, opts = {}) ⇒ Array<(PipelineImpl, Integer, Hash)>

Retrieve pipeline details for an organization folder

Parameters:

  • organization (String) —

    Name of the organization

  • pipeline (String) —

    Name of the pipeline

  • folder (String) —

    Name of the folder

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(PipelineImpl, Integer, Hash)>) —

    PipelineImpl data, response status code and response headers



890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
 
# File 'lib/swaggy_jenkins/api/blue_ocean_api.rb', line 890

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' + '}', CGI.escape(organization.to_s)).sub('{' + 'pipeline' + '}', CGI.escape(pipeline.to_s)).sub('{' + 'folder' + '}', CGI.escape(folder.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

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

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'PipelineImpl'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['jenkins_auth']

  new_options = opts.merge(
    :operation => :"BlueOceanApi.get_pipeline_folder_pipeline",
    :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(:GET, local_var_path, new_options)
  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 = {}) ⇒ Array<(PipelineFolderImpl, Integer, Hash)>

Retrieve pipeline folder for an organization

Parameters:

  • organization (String) —

    Name of the organization

  • folder (String) —

    Name of the folder

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(PipelineFolderImpl, Integer, Hash)>) —

    PipelineFolderImpl data, response status code and response headers



821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
 
# File 'lib/swaggy_jenkins/api/blue_ocean_api.rb', line 821

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' + '}', CGI.escape(organization.to_s)).sub('{' + 'folder' + '}', CGI.escape(folder.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

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

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'PipelineFolderImpl'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['jenkins_auth']

  new_options = opts.merge(
    :operation => :"BlueOceanApi.get_pipeline_folder",
    :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(:GET, local_var_path, new_options)
  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 = {}) ⇒ Array<QueueItemImpl>

Retrieve queue details for an organization pipeline

Parameters:

  • organization (String) —

    Name of the organization

  • pipeline (String) —

    Name of the pipeline

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



951
952
953
954
 
# File 'lib/swaggy_jenkins/api/blue_ocean_api.rb', line 951

def get_pipeline_queue(organization, pipeline, opts = {})
  data, _status_code, _headers = get_pipeline_queue_with_http_info(organization, pipeline, opts)
  data
end

#get_pipeline_queue_with_http_info(organization, pipeline, opts = {}) ⇒ Array<(Array<QueueItemImpl>, Integer, Hash)>

Retrieve queue details for an organization pipeline

Parameters:

  • organization (String) —

    Name of the organization

  • pipeline (String) —

    Name of the pipeline

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Array<QueueItemImpl>, Integer, Hash)>) —

    Array<QueueItemImpl> data, response status code and response headers



961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
 
# File 'lib/swaggy_jenkins/api/blue_ocean_api.rb', line 961

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' + '}', CGI.escape(organization.to_s)).sub('{' + 'pipeline' + '}', CGI.escape(pipeline.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

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

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Array<QueueItemImpl>'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['jenkins_auth']

  new_options = opts.merge(
    :operation => :"BlueOceanApi.get_pipeline_queue",
    :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(:GET, local_var_path, new_options)
  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 = {}) ⇒ PipelineRun

Retrieve run details for an organization pipeline

Parameters:

  • organization (String) —

    Name of the organization

  • pipeline (String) —

    Name of the pipeline

  • run (String) —

    Name of the run

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



1019
1020
1021
1022
 
# File 'lib/swaggy_jenkins/api/blue_ocean_api.rb', line 1019

def get_pipeline_run(organization, pipeline, run, opts = {})
  data, _status_code, _headers = get_pipeline_run_with_http_info(organization, pipeline, run, opts)
  data
end

#get_pipeline_run_log(organization, pipeline, run, opts = {}) ⇒ String

Get log for a pipeline run

Parameters:

  • organization (String) —

    Name of the organization

  • pipeline (String) —

    Name of the pipeline

  • run (String) —

    Name of the run

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :start (Integer) —

    Start position of the log

  • :download (Boolean) —

    Set to true in order to download the file, otherwise it&#39;s passed as a response body

Returns:

  • (String) 


1094
1095
1096
1097
 
# File 'lib/swaggy_jenkins/api/blue_ocean_api.rb', line 1094

def get_pipeline_run_log(organization, pipeline, run, opts = {})
  data, _status_code, _headers = get_pipeline_run_log_with_http_info(organization, pipeline, run, opts)
  data
end

#get_pipeline_run_log_with_http_info(organization, pipeline, run, opts = {}) ⇒ Array<(String, Integer, Hash)>

Get log for a pipeline run

Parameters:

  • organization (String) —

    Name of the organization

  • pipeline (String) —

    Name of the pipeline

  • run (String) —

    Name of the run

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :start (Integer) —

    Start position of the log

  • :download (Boolean) —

    Set to true in order to download the file, otherwise it&#39;s passed as a response body

Returns:

  • (Array<(String, Integer, Hash)>) —

    String data, response status code and response headers



1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
 
# File 'lib/swaggy_jenkins/api/blue_ocean_api.rb', line 1107

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' + '}', CGI.escape(organization.to_s)).sub('{' + 'pipeline' + '}', CGI.escape(pipeline.to_s)).sub('{' + 'run' + '}', CGI.escape(run.to_s))

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

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

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'String'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['jenkins_auth']

  new_options = opts.merge(
    :operation => :"BlueOceanApi.get_pipeline_run_log",
    :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(:GET, local_var_path, new_options)
  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 = {}) ⇒ PipelineRunNode

Retrieve run node details for an organization pipeline

Parameters:

  • organization (String) —

    Name of the organization

  • pipeline (String) —

    Name of the pipeline

  • run (String) —

    Name of the run

  • node (String) —

    Name of the node

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



1172
1173
1174
1175
 
# File 'lib/swaggy_jenkins/api/blue_ocean_api.rb', line 1172

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)
  data
end

#get_pipeline_run_node_step(organization, pipeline, run, node, step, opts = {}) ⇒ PipelineStepImpl

Retrieve run node details for an organization pipeline

Parameters:

  • organization (String) —

    Name of the organization

  • pipeline (String) —

    Name of the pipeline

  • run (String) —

    Name of the run

  • node (String) —

    Name of the node

  • step (String) —

    Name of the step

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



1252
1253
1254
1255
 
# File 'lib/swaggy_jenkins/api/blue_ocean_api.rb', line 1252

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)
  data
end

#get_pipeline_run_node_step_log(organization, pipeline, run, node, step, opts = {}) ⇒ String

Get log for a pipeline run node step

Parameters:

  • organization (String) —

    Name of the organization

  • pipeline (String) —

    Name of the pipeline

  • run (String) —

    Name of the run

  • node (String) —

    Name of the node

  • step (String) —

    Name of the step

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (String) 


1337
1338
1339
1340
 
# File 'lib/swaggy_jenkins/api/blue_ocean_api.rb', line 1337

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)
  data
end

#get_pipeline_run_node_step_log_with_http_info(organization, pipeline, run, node, step, opts = {}) ⇒ Array<(String, Integer, Hash)>

Get log for a pipeline run node step

Parameters:

  • organization (String) —

    Name of the organization

  • pipeline (String) —

    Name of the pipeline

  • run (String) —

    Name of the run

  • node (String) —

    Name of the node

  • step (String) —

    Name of the step

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(String, Integer, Hash)>) —

    String data, response status code and response headers



1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
 
# File 'lib/swaggy_jenkins/api/blue_ocean_api.rb', line 1350

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' + '}', CGI.escape(organization.to_s)).sub('{' + 'pipeline' + '}', CGI.escape(pipeline.to_s)).sub('{' + 'run' + '}', CGI.escape(run.to_s)).sub('{' + 'node' + '}', CGI.escape(node.to_s)).sub('{' + 'step' + '}', CGI.escape(step.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

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

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'String'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['jenkins_auth']

  new_options = opts.merge(
    :operation => :"BlueOceanApi.get_pipeline_run_node_step_log",
    :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(:GET, local_var_path, new_options)
  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 = {}) ⇒ Array<(PipelineStepImpl, Integer, Hash)>

Retrieve run node details for an organization pipeline

Parameters:

  • organization (String) —

    Name of the organization

  • pipeline (String) —

    Name of the pipeline

  • run (String) —

    Name of the run

  • node (String) —

    Name of the node

  • step (String) —

    Name of the step

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(PipelineStepImpl, Integer, Hash)>) —

    PipelineStepImpl data, response status code and response headers



1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
 
# File 'lib/swaggy_jenkins/api/blue_ocean_api.rb', line 1265

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' + '}', CGI.escape(organization.to_s)).sub('{' + 'pipeline' + '}', CGI.escape(pipeline.to_s)).sub('{' + 'run' + '}', CGI.escape(run.to_s)).sub('{' + 'node' + '}', CGI.escape(node.to_s)).sub('{' + 'step' + '}', CGI.escape(step.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

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

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'PipelineStepImpl'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['jenkins_auth']

  new_options = opts.merge(
    :operation => :"BlueOceanApi.get_pipeline_run_node_step",
    :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(:GET, local_var_path, new_options)
  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 = {}) ⇒ Array<PipelineStepImpl>

Retrieve run node steps details for an organization pipeline

Parameters:

  • organization (String) —

    Name of the organization

  • pipeline (String) —

    Name of the pipeline

  • run (String) —

    Name of the run

  • node (String) —

    Name of the node

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



1421
1422
1423
1424
 
# File 'lib/swaggy_jenkins/api/blue_ocean_api.rb', line 1421

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)
  data
end

#get_pipeline_run_node_steps_with_http_info(organization, pipeline, run, node, opts = {}) ⇒ Array<(Array<PipelineStepImpl>, Integer, Hash)>

Retrieve run node steps details for an organization pipeline

Parameters:

  • organization (String) —

    Name of the organization

  • pipeline (String) —

    Name of the pipeline

  • run (String) —

    Name of the run

  • node (String) —

    Name of the node

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Array<PipelineStepImpl>, Integer, Hash)>) —

    Array<PipelineStepImpl> data, response status code and response headers



1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
 
# File 'lib/swaggy_jenkins/api/blue_ocean_api.rb', line 1433

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' + '}', CGI.escape(organization.to_s)).sub('{' + 'pipeline' + '}', CGI.escape(pipeline.to_s)).sub('{' + 'run' + '}', CGI.escape(run.to_s)).sub('{' + 'node' + '}', CGI.escape(node.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

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

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Array<PipelineStepImpl>'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['jenkins_auth']

  new_options = opts.merge(
    :operation => :"BlueOceanApi.get_pipeline_run_node_steps",
    :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(:GET, local_var_path, new_options)
  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 = {}) ⇒ Array<(PipelineRunNode, Integer, Hash)>

Retrieve run node details for an organization pipeline

Parameters:

  • organization (String) —

    Name of the organization

  • pipeline (String) —

    Name of the pipeline

  • run (String) —

    Name of the run

  • node (String) —

    Name of the node

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(PipelineRunNode, Integer, Hash)>) —

    PipelineRunNode data, response status code and response headers



1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
 
# File 'lib/swaggy_jenkins/api/blue_ocean_api.rb', line 1184

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' + '}', CGI.escape(organization.to_s)).sub('{' + 'pipeline' + '}', CGI.escape(pipeline.to_s)).sub('{' + 'run' + '}', CGI.escape(run.to_s)).sub('{' + 'node' + '}', CGI.escape(node.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

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

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'PipelineRunNode'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['jenkins_auth']

  new_options = opts.merge(
    :operation => :"BlueOceanApi.get_pipeline_run_node",
    :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(:GET, local_var_path, new_options)
  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 = {}) ⇒ Array<PipelineRunNode>

Retrieve run nodes details for an organization pipeline

Parameters:

  • organization (String) —

    Name of the organization

  • pipeline (String) —

    Name of the pipeline

  • run (String) —

    Name of the run

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



1499
1500
1501
1502
 
# File 'lib/swaggy_jenkins/api/blue_ocean_api.rb', line 1499

def get_pipeline_run_nodes(organization, pipeline, run, opts = {})
  data, _status_code, _headers = get_pipeline_run_nodes_with_http_info(organization, pipeline, run, opts)
  data
end

#get_pipeline_run_nodes_with_http_info(organization, pipeline, run, opts = {}) ⇒ Array<(Array<PipelineRunNode>, Integer, Hash)>

Retrieve run nodes details for an organization pipeline

Parameters:

  • organization (String) —

    Name of the organization

  • pipeline (String) —

    Name of the pipeline

  • run (String) —

    Name of the run

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Array<PipelineRunNode>, Integer, Hash)>) —

    Array<PipelineRunNode> data, response status code and response headers



1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
 
# File 'lib/swaggy_jenkins/api/blue_ocean_api.rb', line 1510

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' + '}', CGI.escape(organization.to_s)).sub('{' + 'pipeline' + '}', CGI.escape(pipeline.to_s)).sub('{' + 'run' + '}', CGI.escape(run.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

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

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Array<PipelineRunNode>'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['jenkins_auth']

  new_options = opts.merge(
    :operation => :"BlueOceanApi.get_pipeline_run_nodes",
    :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(:GET, local_var_path, new_options)
  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 = {}) ⇒ Array<(PipelineRun, Integer, Hash)>

Retrieve run details for an organization pipeline

Parameters:

  • organization (String) —

    Name of the organization

  • pipeline (String) —

    Name of the pipeline

  • run (String) —

    Name of the run

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(PipelineRun, Integer, Hash)>) —

    PipelineRun data, response status code and response headers



1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
 
# File 'lib/swaggy_jenkins/api/blue_ocean_api.rb', line 1030

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' + '}', CGI.escape(organization.to_s)).sub('{' + 'pipeline' + '}', CGI.escape(pipeline.to_s)).sub('{' + 'run' + '}', CGI.escape(run.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

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

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'PipelineRun'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['jenkins_auth']

  new_options = opts.merge(
    :operation => :"BlueOceanApi.get_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(:GET, local_var_path, new_options)
  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 = {}) ⇒ Array<PipelineRun>

Retrieve all runs details for an organization pipeline

Parameters:

  • organization (String) —

    Name of the organization

  • pipeline (String) —

    Name of the pipeline

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



1571
1572
1573
1574
 
# File 'lib/swaggy_jenkins/api/blue_ocean_api.rb', line 1571

def get_pipeline_runs(organization, pipeline, opts = {})
  data, _status_code, _headers = get_pipeline_runs_with_http_info(organization, pipeline, opts)
  data
end

#get_pipeline_runs_with_http_info(organization, pipeline, opts = {}) ⇒ Array<(Array<PipelineRun>, Integer, Hash)>

Retrieve all runs details for an organization pipeline

Parameters:

  • organization (String) —

    Name of the organization

  • pipeline (String) —

    Name of the pipeline

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Array<PipelineRun>, Integer, Hash)>) —

    Array<PipelineRun> data, response status code and response headers



1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
 
# File 'lib/swaggy_jenkins/api/blue_ocean_api.rb', line 1581

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' + '}', CGI.escape(organization.to_s)).sub('{' + 'pipeline' + '}', CGI.escape(pipeline.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

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

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Array<PipelineRun>'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['jenkins_auth']

  new_options = opts.merge(
    :operation => :"BlueOceanApi.get_pipeline_runs",
    :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(:GET, local_var_path, new_options)
  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 = {}) ⇒ Array<(Pipeline, Integer, Hash)>

Retrieve pipeline details for an organization

Parameters:

  • organization (String) —

    Name of the organization

  • pipeline (String) —

    Name of the pipeline

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Pipeline, Integer, Hash)>) —

    Pipeline data, response status code and response headers



468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
 
# File 'lib/swaggy_jenkins/api/blue_ocean_api.rb', line 468

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' + '}', CGI.escape(organization.to_s)).sub('{' + 'pipeline' + '}', CGI.escape(pipeline.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

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

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Pipeline'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['jenkins_auth']

  new_options = opts.merge(
    :operation => :"BlueOceanApi.get_pipeline",
    :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(:GET, local_var_path, new_options)
  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 = {}) ⇒ Array<Pipeline>

Retrieve all pipelines details for an organization

Parameters:

  • organization (String) —

    Name of the organization

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



1637
1638
1639
1640
 
# File 'lib/swaggy_jenkins/api/blue_ocean_api.rb', line 1637

def get_pipelines(organization, opts = {})
  data, _status_code, _headers = get_pipelines_with_http_info(organization, opts)
  data
end

#get_pipelines_with_http_info(organization, opts = {}) ⇒ Array<(Array<Pipeline>, Integer, Hash)>

Retrieve all pipelines details for an organization

Parameters:

  • organization (String) —

    Name of the organization

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Array<Pipeline>, Integer, Hash)>) —

    Array<Pipeline> data, response status code and response headers



1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
 
# File 'lib/swaggy_jenkins/api/blue_ocean_api.rb', line 1646

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' + '}', CGI.escape(organization.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

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

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Array<Pipeline>'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['jenkins_auth']

  new_options = opts.merge(
    :operation => :"BlueOceanApi.get_pipelines",
    :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(:GET, local_var_path, new_options)
  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 = {}) ⇒ GithubScm

Retrieve SCM details for an organization

Parameters:

  • organization (String) —

    Name of the organization

  • scm (String) —

    Name of SCM

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



1699
1700
1701
1702
 
# File 'lib/swaggy_jenkins/api/blue_ocean_api.rb', line 1699

def get_scm(organization, scm, opts = {})
  data, _status_code, _headers = get_scm_with_http_info(organization, scm, opts)
  data
end

#get_scm_organisation_repositories(organization, scm, scm_organisation, opts = {}) ⇒ Array<GithubOrganization>

Retrieve SCM organization repositories details for an organization

Parameters:

  • organization (String) —

    Name of the organization

  • scm (String) —

    Name of SCM

  • scm_organisation (String) —

    Name of the SCM organization

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :credential_id (String) —

    Credential ID

  • :page_size (Integer) —

    Number of items in a page

  • :page_number (Integer) —

    Page number

Returns:



1770
1771
1772
1773
 
# File 'lib/swaggy_jenkins/api/blue_ocean_api.rb', line 1770

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)
  data
end

#get_scm_organisation_repositories_with_http_info(organization, scm, scm_organisation, opts = {}) ⇒ Array<(Array<GithubOrganization>, Integer, Hash)>

Retrieve SCM organization repositories details for an organization

Parameters:

  • organization (String) —

    Name of the organization

  • scm (String) —

    Name of SCM

  • scm_organisation (String) —

    Name of the SCM organization

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :credential_id (String) —

    Credential ID

  • :page_size (Integer) —

    Number of items in a page

  • :page_number (Integer) —

    Page number

Returns:

  • (Array<(Array<GithubOrganization>, Integer, Hash)>) —

    Array<GithubOrganization> data, response status code and response headers



1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
 
# File 'lib/swaggy_jenkins/api/blue_ocean_api.rb', line 1784

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' + '}', CGI.escape(organization.to_s)).sub('{' + 'scm' + '}', CGI.escape(scm.to_s)).sub('{' + 'scmOrganisation' + '}', CGI.escape(scm_organisation.to_s))

  # query parameters
  query_params = opts[: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 = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Array<GithubOrganization>'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['jenkins_auth']

  new_options = opts.merge(
    :operation => :"BlueOceanApi.get_scm_organisation_repositories",
    :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(:GET, local_var_path, new_options)
  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 = {}) ⇒ Array<GithubOrganization>

Retrieve SCM organization repository details for an organization

Parameters:

  • organization (String) —

    Name of the organization

  • scm (String) —

    Name of SCM

  • scm_organisation (String) —

    Name of the SCM organization

  • repository (String) —

    Name of the SCM repository

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :credential_id (String) —

    Credential ID

Returns:



1851
1852
1853
1854
 
# File 'lib/swaggy_jenkins/api/blue_ocean_api.rb', line 1851

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)
  data
end

#get_scm_organisation_repository_with_http_info(organization, scm, scm_organisation, repository, opts = {}) ⇒ Array<(Array<GithubOrganization>, Integer, Hash)>

Retrieve SCM organization repository details for an organization

Parameters:

  • organization (String) —

    Name of the organization

  • scm (String) —

    Name of SCM

  • scm_organisation (String) —

    Name of the SCM organization

  • repository (String) —

    Name of the SCM repository

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :credential_id (String) —

    Credential ID

Returns:

  • (Array<(Array<GithubOrganization>, Integer, Hash)>) —

    Array<GithubOrganization> data, response status code and response headers



1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
 
# File 'lib/swaggy_jenkins/api/blue_ocean_api.rb', line 1864

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' + '}', CGI.escape(organization.to_s)).sub('{' + 'scm' + '}', CGI.escape(scm.to_s)).sub('{' + 'scmOrganisation' + '}', CGI.escape(scm_organisation.to_s)).sub('{' + 'repository' + '}', CGI.escape(repository.to_s))

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

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

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Array<GithubOrganization>'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['jenkins_auth']

  new_options = opts.merge(
    :operation => :"BlueOceanApi.get_scm_organisation_repository",
    :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(:GET, local_var_path, new_options)
  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 = {}) ⇒ Array<GithubOrganization>

Retrieve SCM organizations details for an organization

Parameters:

  • organization (String) —

    Name of the organization

  • scm (String) —

    Name of SCM

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :credential_id (String) —

    Credential ID

Returns:



1931
1932
1933
1934
 
# File 'lib/swaggy_jenkins/api/blue_ocean_api.rb', line 1931

def get_scm_organisations(organization, scm, opts = {})
  data, _status_code, _headers = get_scm_organisations_with_http_info(organization, scm, opts)
  data
end

#get_scm_organisations_with_http_info(organization, scm, opts = {}) ⇒ Array<(Array<GithubOrganization>, Integer, Hash)>

Retrieve SCM organizations details for an organization

Parameters:

  • organization (String) —

    Name of the organization

  • scm (String) —

    Name of SCM

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :credential_id (String) —

    Credential ID

Returns:

  • (Array<(Array<GithubOrganization>, Integer, Hash)>) —

    Array<GithubOrganization> data, response status code and response headers



1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
 
# File 'lib/swaggy_jenkins/api/blue_ocean_api.rb', line 1942

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' + '}', CGI.escape(organization.to_s)).sub('{' + 'scm' + '}', CGI.escape(scm.to_s))

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

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

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Array<GithubOrganization>'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['jenkins_auth']

  new_options = opts.merge(
    :operation => :"BlueOceanApi.get_scm_organisations",
    :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(:GET, local_var_path, new_options)
  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 = {}) ⇒ Array<(GithubScm, Integer, Hash)>

Retrieve SCM details for an organization

Parameters:

  • organization (String) —

    Name of the organization

  • scm (String) —

    Name of SCM

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(GithubScm, Integer, Hash)>) —

    GithubScm data, response status code and response headers



1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
 
# File 'lib/swaggy_jenkins/api/blue_ocean_api.rb', line 1709

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' + '}', CGI.escape(organization.to_s)).sub('{' + 'scm' + '}', CGI.escape(scm.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

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

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'GithubScm'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['jenkins_auth']

  new_options = opts.merge(
    :operation => :"BlueOceanApi.get_scm",
    :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(:GET, local_var_path, new_options)
  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 = {}) ⇒ User

Retrieve user details for an organization

Parameters:

  • organization (String) —

    Name of the organization

  • user (String) —

    Name of the user

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



2000
2001
2002
2003
 
# File 'lib/swaggy_jenkins/api/blue_ocean_api.rb', line 2000

def get_user(organization, user, opts = {})
  data, _status_code, _headers = get_user_with_http_info(organization, user, opts)
  data
end

#get_user_favorites(user, opts = {}) ⇒ Array<FavoriteImpl>

Retrieve user favorites details for an organization

Parameters:

  • user (String) —

    Name of the user

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



2066
2067
2068
2069
 
# File 'lib/swaggy_jenkins/api/blue_ocean_api.rb', line 2066

def get_user_favorites(user, opts = {})
  data, _status_code, _headers = get_user_favorites_with_http_info(user, opts)
  data
end

#get_user_favorites_with_http_info(user, opts = {}) ⇒ Array<(Array<FavoriteImpl>, Integer, Hash)>

Retrieve user favorites details for an organization

Parameters:

  • user (String) —

    Name of the user

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Array<FavoriteImpl>, Integer, Hash)>) —

    Array<FavoriteImpl> data, response status code and response headers



2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
 
# File 'lib/swaggy_jenkins/api/blue_ocean_api.rb', line 2075

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' + '}', CGI.escape(user.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

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

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Array<FavoriteImpl>'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['jenkins_auth']

  new_options = opts.merge(
    :operation => :"BlueOceanApi.get_user_favorites",
    :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(:GET, local_var_path, new_options)
  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 = {}) ⇒ Array<(User, Integer, Hash)>

Retrieve user details for an organization

Parameters:

  • organization (String) —

    Name of the organization

  • user (String) —

    Name of the user

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(User, Integer, Hash)>) —

    User data, response status code and response headers



2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
 
# File 'lib/swaggy_jenkins/api/blue_ocean_api.rb', line 2010

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' + '}', CGI.escape(organization.to_s)).sub('{' + 'user' + '}', CGI.escape(user.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

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

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'User'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['jenkins_auth']

  new_options = opts.merge(
    :operation => :"BlueOceanApi.get_user",
    :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(:GET, local_var_path, new_options)
  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 = {}) ⇒ User

Retrieve users details for an organization

Parameters:

  • organization (String) —

    Name of the organization

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



2127
2128
2129
2130
 
# File 'lib/swaggy_jenkins/api/blue_ocean_api.rb', line 2127

def get_users(organization, opts = {})
  data, _status_code, _headers = get_users_with_http_info(organization, opts)
  data
end

#get_users_with_http_info(organization, opts = {}) ⇒ Array<(User, Integer, Hash)>

Retrieve users details for an organization

Parameters:

  • organization (String) —

    Name of the organization

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(User, Integer, Hash)>) —

    User data, response status code and response headers



2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
 
# File 'lib/swaggy_jenkins/api/blue_ocean_api.rb', line 2136

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' + '}', CGI.escape(organization.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

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

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'User'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['jenkins_auth']

  new_options = opts.merge(
    :operation => :"BlueOceanApi.get_users",
    :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(:GET, local_var_path, new_options)
  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 = {}) ⇒ QueueItemImpl

Replay an organization pipeline run

Parameters:

  • organization (String) —

    Name of the organization

  • pipeline (String) —

    Name of the pipeline

  • run (String) —

    Name of the run

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



2190
2191
2192
2193
 
# File 'lib/swaggy_jenkins/api/blue_ocean_api.rb', line 2190

def post_pipeline_run(organization, pipeline, run, opts = {})
  data, _status_code, _headers = post_pipeline_run_with_http_info(organization, pipeline, run, opts)
  data
end

#post_pipeline_run_with_http_info(organization, pipeline, run, opts = {}) ⇒ Array<(QueueItemImpl, Integer, Hash)>

Replay an organization pipeline run

Parameters:

  • organization (String) —

    Name of the organization

  • pipeline (String) —

    Name of the pipeline

  • run (String) —

    Name of the run

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(QueueItemImpl, Integer, Hash)>) —

    QueueItemImpl data, response status code and response headers



2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
 
# File 'lib/swaggy_jenkins/api/blue_ocean_api.rb', line 2201

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' + '}', CGI.escape(organization.to_s)).sub('{' + 'pipeline' + '}', CGI.escape(pipeline.to_s)).sub('{' + 'run' + '}', CGI.escape(run.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

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

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'QueueItemImpl'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['jenkins_auth']

  new_options = opts.merge(
    :operation => :"BlueOceanApi.post_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(:POST, local_var_path, new_options)
  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 = {}) ⇒ QueueItemImpl

Start a build for an organization pipeline

Parameters:

  • organization (String) —

    Name of the organization

  • pipeline (String) —

    Name of the pipeline

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



2262
2263
2264
2265
 
# File 'lib/swaggy_jenkins/api/blue_ocean_api.rb', line 2262

def post_pipeline_runs(organization, pipeline, opts = {})
  data, _status_code, _headers = post_pipeline_runs_with_http_info(organization, pipeline, opts)
  data
end

#post_pipeline_runs_with_http_info(organization, pipeline, opts = {}) ⇒ Array<(QueueItemImpl, Integer, Hash)>

Start a build for an organization pipeline

Parameters:

  • organization (String) —

    Name of the organization

  • pipeline (String) —

    Name of the pipeline

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(QueueItemImpl, Integer, Hash)>) —

    QueueItemImpl data, response status code and response headers



2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
 
# File 'lib/swaggy_jenkins/api/blue_ocean_api.rb', line 2272

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' + '}', CGI.escape(organization.to_s)).sub('{' + 'pipeline' + '}', CGI.escape(pipeline.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

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

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'QueueItemImpl'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['jenkins_auth']

  new_options = opts.merge(
    :operation => :"BlueOceanApi.post_pipeline_runs",
    :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(:POST, local_var_path, new_options)
  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 = {}) ⇒ FavoriteImpl

Favorite/unfavorite a pipeline

Parameters:

  • organization (String) —

    Name of the organization

  • pipeline (String) —

    Name of the pipeline

  • body (Boolean) —

    Set JSON string body to true to favorite, set value to false to unfavorite

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



2330
2331
2332
2333
 
# File 'lib/swaggy_jenkins/api/blue_ocean_api.rb', line 2330

def put_pipeline_favorite(organization, pipeline, body, opts = {})
  data, _status_code, _headers = put_pipeline_favorite_with_http_info(organization, pipeline, body, opts)
  data
end

#put_pipeline_favorite_with_http_info(organization, pipeline, body, opts = {}) ⇒ Array<(FavoriteImpl, Integer, Hash)>

Favorite/unfavorite a pipeline

Parameters:

  • organization (String) —

    Name of the organization

  • pipeline (String) —

    Name of the pipeline

  • body (Boolean) —

    Set JSON string body to true to favorite, set value to false to unfavorite

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(FavoriteImpl, Integer, Hash)>) —

    FavoriteImpl data, response status code and response headers



2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
 
# File 'lib/swaggy_jenkins/api/blue_ocean_api.rb', line 2341

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' + '}', CGI.escape(organization.to_s)).sub('{' + 'pipeline' + '}', CGI.escape(pipeline.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(body)

  # return_type
  return_type = opts[:debug_return_type] || 'FavoriteImpl'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['jenkins_auth']

  new_options = opts.merge(
    :operation => :"BlueOceanApi.put_pipeline_favorite",
    :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_favorite\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_pipeline_run(organization, pipeline, run, opts = {}) ⇒ PipelineRun

Stop a build of an organization pipeline

Parameters:

  • organization (String) —

    Name of the organization

  • pipeline (String) —

    Name of the pipeline

  • run (String) —

    Name of the run

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :blocking (String) —

    Set to true to make blocking stop, default: false

  • :time_out_in_secs (Integer) —

    Timeout in seconds, default: 10 seconds

Returns:



2410
2411
2412
2413
 
# File 'lib/swaggy_jenkins/api/blue_ocean_api.rb', line 2410

def put_pipeline_run(organization, pipeline, run, opts = {})
  data, _status_code, _headers = put_pipeline_run_with_http_info(organization, pipeline, run, opts)
  data
end

#put_pipeline_run_with_http_info(organization, pipeline, run, opts = {}) ⇒ Array<(PipelineRun, Integer, Hash)>

Stop a build of an organization pipeline

Parameters:

  • organization (String) —

    Name of the organization

  • pipeline (String) —

    Name of the pipeline

  • run (String) —

    Name of the run

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :blocking (String) —

    Set to true to make blocking stop, default: false

  • :time_out_in_secs (Integer) —

    Timeout in seconds, default: 10 seconds

Returns:

  • (Array<(PipelineRun, Integer, Hash)>) —

    PipelineRun data, response status code and response headers



2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
 
# File 'lib/swaggy_jenkins/api/blue_ocean_api.rb', line 2423

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' + '}', CGI.escape(organization.to_s)).sub('{' + 'pipeline' + '}', CGI.escape(pipeline.to_s)).sub('{' + 'run' + '}', CGI.escape(run.to_s))

  # query parameters
  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 parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'PipelineRun'

  # auth_names
  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

#search(q, opts = {}) ⇒ String

Search for any resource details

Parameters:

  • q (String) —

    Query string

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (String) 


2485
2486
2487
2488
 
# File 'lib/swaggy_jenkins/api/blue_ocean_api.rb', line 2485

def search(q, opts = {})
  data, _status_code, _headers = search_with_http_info(q, opts)
  data
end

#search_classes(q, opts = {}) ⇒ String

Get classes details

Parameters:

  • q (String) —

    Query string containing an array of class names

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (String) 


2547
2548
2549
2550
 
# File 'lib/swaggy_jenkins/api/blue_ocean_api.rb', line 2547

def search_classes(q, opts = {})
  data, _status_code, _headers = search_classes_with_http_info(q, opts)
  data
end

#search_classes_with_http_info(q, opts = {}) ⇒ Array<(String, Integer, Hash)>

Get classes details

Parameters:

  • q (String) —

    Query string containing an array of class names

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(String, Integer, Hash)>) —

    String data, response status code and response headers



2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
 
# File 'lib/swaggy_jenkins/api/blue_ocean_api.rb', line 2556

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 = opts[:query_params] || {}
  query_params[:'q'] = q

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

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'String'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['jenkins_auth']

  new_options = opts.merge(
    :operation => :"BlueOceanApi.search_classes",
    :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(:GET, local_var_path, new_options)
  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 = {}) ⇒ Array<(String, Integer, Hash)>

Search for any resource details

Parameters:

  • q (String) —

    Query string

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(String, Integer, Hash)>) —

    String data, response status code and response headers



2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
 
# File 'lib/swaggy_jenkins/api/blue_ocean_api.rb', line 2494

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 = opts[:query_params] || {}
  query_params[:'q'] = q

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

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'String'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['jenkins_auth']

  new_options = opts.merge(
    :operation => :"BlueOceanApi.search",
    :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(:GET, local_var_path, new_options)
  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