Class: SwaggerClient::PipelineTemplatesControllerApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ PipelineTemplatesControllerApi

Returns a new instance of PipelineTemplatesControllerApi.



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

def api_client
  @api_client
end

Instance Method Details

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

Create a pipeline template.

Parameters:

  • pipeline_template —

    pipelineTemplate

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

    the optional parameters

Returns:

  • (nil) 


26
27
28
29
 
# File 'lib/swagger_client/api/pipeline_templates_controller_api.rb', line 26

def create_using_post(pipeline_template, opts = {})
  create_using_post_with_http_info(pipeline_template, opts)
  nil
end

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

Create a pipeline template.

Parameters:

  • pipeline_template —

    pipelineTemplate

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



35
36
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
 
# File 'lib/swagger_client/api/pipeline_templates_controller_api.rb', line 35

def create_using_post_with_http_info(pipeline_template, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PipelineTemplatesControllerApi.create_using_post ...'
  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 PipelineTemplatesControllerApi.create_using_post"
  end
  # resource path
  local_var_path = '/pipelineTemplates'

  # 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_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: PipelineTemplatesControllerApi#create_using_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Delete a pipeline template.

Parameters:

  • id —

    id

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

    the optional parameters

Options Hash (opts):

  • :application (String) —

    application

Returns:

  • (Hash<String, Object>) 


78
79
80
81
 
# File 'lib/swagger_client/api/pipeline_templates_controller_api.rb', line 78

def delete_using_delete(id, opts = {})
  data, _status_code, _headers = delete_using_delete_with_http_info(id, opts)
  data
end

#delete_using_delete_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):

  • :application (String) —

    application

Returns:

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

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



88
89
90
91
92
93
94
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
 
# File 'lib/swagger_client/api/pipeline_templates_controller_api.rb', line 88

def delete_using_delete_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PipelineTemplatesControllerApi.delete_using_delete ...'
  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 PipelineTemplatesControllerApi.delete_using_delete"
  end
  # resource path
  local_var_path = '/pipelineTemplates/{id}'.sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}
  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: PipelineTemplatesControllerApi#delete_using_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Get a pipeline template.

Parameters:

  • id —

    id

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

    the optional parameters

Returns:

  • (Hash<String, Object>) 


132
133
134
135
 
# File 'lib/swagger_client/api/pipeline_templates_controller_api.rb', line 132

def get_using_get(id, opts = {})
  data, _status_code, _headers = get_using_get_with_http_info(id, opts)
  data
end

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

Get a pipeline template.

Parameters:

  • id —

    id

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

    the optional parameters

Returns:

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

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



141
142
143
144
145
146
147
148
149
150
151
152
153
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
 
# File 'lib/swagger_client/api/pipeline_templates_controller_api.rb', line 141

def get_using_get_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PipelineTemplatesControllerApi.get_using_get ...'
  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 PipelineTemplatesControllerApi.get_using_get"
  end
  # resource path
  local_var_path = '/pipelineTemplates/{id}'.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 => 'Hash<String, Object>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PipelineTemplatesControllerApi#get_using_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

List all pipelines that implement a pipeline template

Parameters:

  • id —

    id

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

    the optional parameters

Options Hash (opts):

  • :recursive (BOOLEAN) —

    recursive

Returns:

  • (Array<Object>) 


185
186
187
188
 
# File 'lib/swagger_client/api/pipeline_templates_controller_api.rb', line 185

def list_pipeline_template_dependents_using_get(id, opts = {})
  data, _status_code, _headers = list_pipeline_template_dependents_using_get_with_http_info(id, opts)
  data
end

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

List all pipelines that implement a pipeline template

Parameters:

  • id —

    id

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

    the optional parameters

Options Hash (opts):

  • :recursive (BOOLEAN) —

    recursive

Returns:

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

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



195
196
197
198
199
200
201
202
203
204
205
206
207
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
 
# File 'lib/swagger_client/api/pipeline_templates_controller_api.rb', line 195

def list_pipeline_template_dependents_using_get_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PipelineTemplatesControllerApi.list_pipeline_template_dependents_using_get ...'
  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 PipelineTemplatesControllerApi.list_pipeline_template_dependents_using_get"
  end
  # resource path
  local_var_path = '/pipelineTemplates/{id}/dependents'.sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}
  query_params[:'recursive'] = opts[:'recursive'] if !opts[:'recursive'].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: PipelineTemplatesControllerApi#list_pipeline_template_dependents_using_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

List pipeline templates.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :scopes (Array<String>) —

    scopes

Returns:

  • (Array<Object>) 


239
240
241
242
 
# File 'lib/swagger_client/api/pipeline_templates_controller_api.rb', line 239

def list_using_get(opts = {})
  data, _status_code, _headers = list_using_get_with_http_info(opts)
  data
end

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

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



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
275
276
277
278
279
280
281
282
283
 
# File 'lib/swagger_client/api/pipeline_templates_controller_api.rb', line 248

def list_using_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PipelineTemplatesControllerApi.list_using_get ...'
  end
  # resource path
  local_var_path = '/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: PipelineTemplatesControllerApi#list_using_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#resolve_templates_using_get(source, opts = {}) ⇒ Hash<String, Object>

Resolve a pipeline template.

Parameters:

  • source —

    source

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

    the optional parameters

Options Hash (opts):

  • :execution_id (String) —

    executionId

  • :pipeline_config_id (String) —

    pipelineConfigId

Returns:

  • (Hash<String, Object>) 


290
291
292
293
 
# File 'lib/swagger_client/api/pipeline_templates_controller_api.rb', line 290

def resolve_templates_using_get(source, opts = {})
  data, _status_code, _headers = resolve_templates_using_get_with_http_info(source, opts)
  data
end

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

Resolve a pipeline template.

Parameters:

  • source —

    source

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

    the optional parameters

Options Hash (opts):

  • :execution_id (String) —

    executionId

  • :pipeline_config_id (String) —

    pipelineConfigId

Returns:

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

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



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
336
337
338
339
340
341
342
 
# File 'lib/swagger_client/api/pipeline_templates_controller_api.rb', line 301

def resolve_templates_using_get_with_http_info(source, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PipelineTemplatesControllerApi.resolve_templates_using_get ...'
  end
  # verify the required parameter 'source' is set
  if @api_client.config.client_side_validation && source.nil?
    fail ArgumentError, "Missing the required parameter 'source' when calling PipelineTemplatesControllerApi.resolve_templates_using_get"
  end
  # resource path
  local_var_path = '/pipelineTemplates/resolve'

  # query parameters
  query_params = {}
  query_params[:'source'] = source
  query_params[:'executionId'] = opts[:'execution_id'] if !opts[:'execution_id'].nil?
  query_params[:'pipelineConfigId'] = opts[:'pipeline_config_id'] if !opts[:'pipeline_config_id'].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: PipelineTemplatesControllerApi#resolve_templates_using_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Update a pipeline template.

Parameters:

  • id —

    id

  • pipeline_template —

    pipelineTemplate

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

    the optional parameters

Options Hash (opts):

  • :skip_plan_dependents (BOOLEAN) —

    skipPlanDependents (default to false)

Returns:

  • (nil) 


349
350
351
352
 
# File 'lib/swagger_client/api/pipeline_templates_controller_api.rb', line 349

def update_using_post(id, pipeline_template, opts = {})
  update_using_post_with_http_info(id, pipeline_template, opts)
  nil
end

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

Update a pipeline template.

Parameters:

  • id —

    id

  • pipeline_template —

    pipelineTemplate

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

    the optional parameters

Options Hash (opts):

  • :skip_plan_dependents (BOOLEAN) —

    skipPlanDependents

Returns:

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

    nil, response status code and response headers



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
397
398
399
400
401
402
 
# File 'lib/swagger_client/api/pipeline_templates_controller_api.rb', line 360

def update_using_post_with_http_info(id, pipeline_template, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PipelineTemplatesControllerApi.update_using_post ...'
  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 PipelineTemplatesControllerApi.update_using_post"
  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 PipelineTemplatesControllerApi.update_using_post"
  end
  # resource path
  local_var_path = '/pipelineTemplates/{id}'.sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}
  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: PipelineTemplatesControllerApi#update_using_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end