Class: SwaggerClient::V2PipelineTemplatesControllerApi

Inherits:
Object
  • Object
show all
Defined in:
lib/swagger_client/api/v2_pipeline_templates_controller_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ V2PipelineTemplatesControllerApi

Returns a new instance of V2PipelineTemplatesControllerApi.



19
20
21
 
# File 'lib/swagger_client/api/v2_pipeline_templates_controller_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/swagger_client/api/v2_pipeline_templates_controller_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#create_using_post1(pipeline_template, opts = {}) ⇒ nil

(ALPHA) Create a pipeline template.

Parameters:

  • pipeline_template —

    pipelineTemplate

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

    the optional parameters

Options Hash (opts):

  • :tag (String) —

    tag

Returns:

  • (nil) 


27
28
29
30
 
# File 'lib/swagger_client/api/v2_pipeline_templates_controller_api.rb', line 27

def create_using_post1(pipeline_template, opts = {})
  create_using_post1_with_http_info(pipeline_template, opts)
  nil
end

#create_using_post1_with_http_info(pipeline_template, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

(ALPHA) Create a pipeline template.

Parameters:

  • pipeline_template —

    pipelineTemplate

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

    the optional parameters

Options Hash (opts):

  • :tag (String) —

    tag

Returns:

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

    nil, response status code and response headers



37
38
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
 
# File 'lib/swagger_client/api/v2_pipeline_templates_controller_api.rb', line 37

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

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

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

  # form parameters
  form_params = {}

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

#delete_using_delete1(id, opts = {}) ⇒ Hash<String, Object>

Delete a pipeline template.

Parameters:

  • id —

    id

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

    the optional parameters

Options Hash (opts):

  • :tag (String) —

    tag

  • :digest (String) —

    digest

  • :application (String) —

    application

Returns:

  • (Hash<String, Object>) 


83
84
85
86
 
# File 'lib/swagger_client/api/v2_pipeline_templates_controller_api.rb', line 83

def delete_using_delete1(id, opts = {})
  data, _status_code, _headers = delete_using_delete1_with_http_info(id, opts)
  data
end

#delete_using_delete1_with_http_info(id, opts = {}) ⇒ Array<(Hash<String, Object>, Fixnum, Hash)>

Delete a pipeline template.

Parameters:

  • id —

    id

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

    the optional parameters

Options Hash (opts):

  • :tag (String) —

    tag

  • :digest (String) —

    digest

  • :application (String) —

    application

Returns:

  • (Array<(Hash<String, Object>, Fixnum, Hash)>) —

    Hash<String, Object> data, response status code and response headers



95
96
97
98
99
100
101
102
103
104
105
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
 
# File 'lib/swagger_client/api/v2_pipeline_templates_controller_api.rb', line 95

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

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

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

  # form parameters
  form_params = {}

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

#get_using_get2(id, opts = {}) ⇒ Hash<String, Object>

(ALPHA) Get a pipeline template.

Parameters:

  • id —

    id

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

    the optional parameters

Options Hash (opts):

  • :tag (String) —

    tag

  • :digest (String) —

    digest

Returns:

  • (Hash<String, Object>) 


143
144
145
146
 
# File 'lib/swagger_client/api/v2_pipeline_templates_controller_api.rb', line 143

def get_using_get2(id, opts = {})
  data, _status_code, _headers = get_using_get2_with_http_info(id, opts)
  data
end

#get_using_get2_with_http_info(id, opts = {}) ⇒ Array<(Hash<String, Object>, Fixnum, Hash)>

(ALPHA) Get a pipeline template.

Parameters:

  • id —

    id

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

    the optional parameters

Options Hash (opts):

  • :tag (String) —

    tag

  • :digest (String) —

    digest

Returns:

  • (Array<(Hash<String, Object>, Fixnum, Hash)>) —

    Hash<String, Object> data, response status code and response headers



154
155
156
157
158
159
160
161
162
163
164
165
166
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
 
# File 'lib/swagger_client/api/v2_pipeline_templates_controller_api.rb', line 154

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

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

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

  # form parameters
  form_params = {}

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

#list_pipeline_template_dependents_using_get1(id, opts = {}) ⇒ Array<Object>

(ALPHA) List all pipelines that implement a pipeline template

Parameters:

  • id —

    id

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

    the optional parameters

Returns:

  • (Array<Object>) 


199
200
201
202
 
# File 'lib/swagger_client/api/v2_pipeline_templates_controller_api.rb', line 199

def list_pipeline_template_dependents_using_get1(id, opts = {})
  data, _status_code, _headers = list_pipeline_template_dependents_using_get1_with_http_info(id, opts)
  data
end

#list_pipeline_template_dependents_using_get1_with_http_info(id, opts = {}) ⇒ Array<(Array<Object>, Fixnum, Hash)>

(ALPHA) List all pipelines that implement a pipeline template

Parameters:

  • id —

    id

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

    the optional parameters

Returns:

  • (Array<(Array<Object>, Fixnum, Hash)>) —

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



208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
 
# File 'lib/swagger_client/api/v2_pipeline_templates_controller_api.rb', line 208

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

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

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

#list_using_get1(opts = {}) ⇒ Array<Object>

(ALPHA) List pipeline templates.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :scopes (Array<String>) —

    scopes

Returns:

  • (Array<Object>) 


251
252
253
254
 
# File 'lib/swagger_client/api/v2_pipeline_templates_controller_api.rb', line 251

def list_using_get1(opts = {})
  data, _status_code, _headers = list_using_get1_with_http_info(opts)
  data
end

#list_using_get1_with_http_info(opts = {}) ⇒ Array<(Array<Object>, Fixnum, Hash)>

(ALPHA) List pipeline templates.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :scopes (Array<String>) —

    scopes

Returns:

  • (Array<(Array<Object>, Fixnum, Hash)>) —

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



260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
 
# File 'lib/swagger_client/api/v2_pipeline_templates_controller_api.rb', line 260

def list_using_get1_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: V2PipelineTemplatesControllerApi.list_using_get1 ...'
  end
  # resource path
  local_var_path = '/v2/pipelineTemplates'

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

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

  # form parameters
  form_params = {}

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

#plan_using_post(pipeline, opts = {}) ⇒ Hash<String, Object>

(ALPHA) Plan a pipeline template configuration.

Parameters:

  • pipeline —

    pipeline

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

    the optional parameters

Returns:

  • (Hash<String, Object>) 


300
301
302
303
 
# File 'lib/swagger_client/api/v2_pipeline_templates_controller_api.rb', line 300

def plan_using_post(pipeline, opts = {})
  data, _status_code, _headers = plan_using_post_with_http_info(pipeline, opts)
  data
end

#plan_using_post_with_http_info(pipeline, opts = {}) ⇒ Array<(Hash<String, Object>, Fixnum, Hash)>

(ALPHA) Plan a pipeline template configuration.

Parameters:

  • pipeline —

    pipeline

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

    the optional parameters

Returns:

  • (Array<(Hash<String, Object>, Fixnum, Hash)>) —

    Hash<String, Object> data, response status code and response headers



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
336
337
338
339
340
341
342
343
344
345
346
347
 
# File 'lib/swagger_client/api/v2_pipeline_templates_controller_api.rb', line 309

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

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

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

#update_using_post1(id, pipeline_template, opts = {}) ⇒ nil

(ALPHA) Update a pipeline template.

Parameters:

  • id —

    id

  • pipeline_template —

    pipelineTemplate

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

    the optional parameters

Options Hash (opts):

  • :tag (String) —

    tag

  • :skip_plan_dependents (BOOLEAN) —

    skipPlanDependents (default to false)

Returns:

  • (nil) 


355
356
357
358
 
# File 'lib/swagger_client/api/v2_pipeline_templates_controller_api.rb', line 355

def update_using_post1(id, pipeline_template, opts = {})
  update_using_post1_with_http_info(id, pipeline_template, opts)
  nil
end

#update_using_post1_with_http_info(id, pipeline_template, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

(ALPHA) Update a pipeline template.

Parameters:

  • id —

    id

  • pipeline_template —

    pipelineTemplate

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

    the optional parameters

Options Hash (opts):

  • :tag (String) —

    tag

  • :skip_plan_dependents (BOOLEAN) —

    skipPlanDependents

Returns:

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

    nil, response status code and response headers



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
397
398
399
400
401
402
403
404
405
406
407
408
409
410
 
# File 'lib/swagger_client/api/v2_pipeline_templates_controller_api.rb', line 367

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

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

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

  # form parameters
  form_params = {}

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