Class: ArgoWorkflows::ArtifactServiceApi

Inherits:
Object
  • Object
show all
Defined in:
lib/argo_workflows/api/artifact_service_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ArtifactServiceApi

Returns a new instance of ArtifactServiceApi.



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

def api_client
  @api_client
end

Instance Method Details

#artifact_service_get_artifact_file(namespace, id_discriminator, id, node_id, artifact_name, artifact_discriminator, opts = {}) ⇒ String

Get an artifact.

Parameters:

  • namespace
  • id_discriminator
  • id
  • node_id
  • artifact_name
  • artifact_discriminator
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (String) 


31
32
33
34
 
# File 'lib/argo_workflows/api/artifact_service_api.rb', line 31

def artifact_service_get_artifact_file(namespace, id_discriminator, id, node_id, artifact_name, artifact_discriminator, opts = {})
  data, _status_code, _headers = artifact_service_get_artifact_file_with_http_info(namespace, id_discriminator, id, node_id, artifact_name, artifact_discriminator, opts)
  data
end

#artifact_service_get_artifact_file_with_http_info(namespace, id_discriminator, id, node_id, artifact_name, artifact_discriminator, opts = {}) ⇒ Array<(String, Fixnum, Hash)>

Get an artifact.

Parameters:

  • namespace
  • id_discriminator
  • id
  • node_id
  • artifact_name
  • artifact_discriminator
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

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

    String data, response status code and response headers



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
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'lib/argo_workflows/api/artifact_service_api.rb', line 45

def artifact_service_get_artifact_file_with_http_info(namespace, id_discriminator, id, node_id, artifact_name, artifact_discriminator, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ArtifactServiceApi.artifact_service_get_artifact_file ...'
  end
  # verify the required parameter 'namespace' is set
  if @api_client.config.client_side_validation && namespace.nil?
    fail ArgumentError, "Missing the required parameter 'namespace' when calling ArtifactServiceApi.artifact_service_get_artifact_file"
  end
  # verify the required parameter 'id_discriminator' is set
  if @api_client.config.client_side_validation && id_discriminator.nil?
    fail ArgumentError, "Missing the required parameter 'id_discriminator' when calling ArtifactServiceApi.artifact_service_get_artifact_file"
  end
  # verify enum value
  if @api_client.config.client_side_validation && !['workflow', 'archived-workflows'].include?(id_discriminator)
    fail ArgumentError, "invalid value for 'id_discriminator', must be one of workflow, archived-workflows"
  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 ArtifactServiceApi.artifact_service_get_artifact_file"
  end
  # verify the required parameter 'node_id' is set
  if @api_client.config.client_side_validation && node_id.nil?
    fail ArgumentError, "Missing the required parameter 'node_id' when calling ArtifactServiceApi.artifact_service_get_artifact_file"
  end
  # verify the required parameter 'artifact_name' is set
  if @api_client.config.client_side_validation && artifact_name.nil?
    fail ArgumentError, "Missing the required parameter 'artifact_name' when calling ArtifactServiceApi.artifact_service_get_artifact_file"
  end
  # verify the required parameter 'artifact_discriminator' is set
  if @api_client.config.client_side_validation && artifact_discriminator.nil?
    fail ArgumentError, "Missing the required parameter 'artifact_discriminator' when calling ArtifactServiceApi.artifact_service_get_artifact_file"
  end
  # verify enum value
  if @api_client.config.client_side_validation && !['outputs'].include?(artifact_discriminator)
    fail ArgumentError, "invalid value for 'artifact_discriminator', must be one of outputs"
  end
  # resource path
  local_var_path = '/artifact-files/{namespace}/{idDiscriminator}/{id}/{nodeId}/{artifactDiscriminator}/{artifactName}'.sub('{' + 'namespace' + '}', namespace.to_s).sub('{' + 'idDiscriminator' + '}', id_discriminator.to_s).sub('{' + 'id' + '}', id.to_s).sub('{' + 'nodeId' + '}', node_id.to_s).sub('{' + 'artifactName' + '}', artifact_name.to_s).sub('{' + 'artifactDiscriminator' + '}', artifact_discriminator.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # 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 = ['BearerToken']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'String')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ArtifactServiceApi#artifact_service_get_artifact_file\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#artifact_service_get_input_artifact(namespace, name, node_id, artifact_name, opts = {}) ⇒ String

Get an input artifact.

Parameters:

  • namespace
  • name
  • node_id
  • artifact_name
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (String) 


119
120
121
122
 
# File 'lib/argo_workflows/api/artifact_service_api.rb', line 119

def artifact_service_get_input_artifact(namespace, name, node_id, artifact_name, opts = {})
  data, _status_code, _headers = artifact_service_get_input_artifact_with_http_info(namespace, name, node_id, artifact_name, opts)
  data
end

#artifact_service_get_input_artifact_by_uid(uid, node_id, artifact_name, opts = {}) ⇒ String

Get an input artifact by UID.

Parameters:

  • uid
  • node_id
  • artifact_name
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (String) 


188
189
190
191
 
# File 'lib/argo_workflows/api/artifact_service_api.rb', line 188

def artifact_service_get_input_artifact_by_uid(uid, node_id, artifact_name, opts = {})
  data, _status_code, _headers = artifact_service_get_input_artifact_by_uid_with_http_info(uid, node_id, artifact_name, opts)
  data
end

#artifact_service_get_input_artifact_by_uid_with_http_info(uid, node_id, artifact_name, opts = {}) ⇒ Array<(String, Fixnum, Hash)>

Get an input artifact by UID.

Parameters:

  • uid
  • node_id
  • artifact_name
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

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

    String data, response status code and response headers



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
235
236
237
238
239
240
241
242
243
244
245
 
# File 'lib/argo_workflows/api/artifact_service_api.rb', line 199

def artifact_service_get_input_artifact_by_uid_with_http_info(uid, node_id, artifact_name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ArtifactServiceApi.artifact_service_get_input_artifact_by_uid ...'
  end
  # verify the required parameter 'uid' is set
  if @api_client.config.client_side_validation && uid.nil?
    fail ArgumentError, "Missing the required parameter 'uid' when calling ArtifactServiceApi.artifact_service_get_input_artifact_by_uid"
  end
  # verify the required parameter 'node_id' is set
  if @api_client.config.client_side_validation && node_id.nil?
    fail ArgumentError, "Missing the required parameter 'node_id' when calling ArtifactServiceApi.artifact_service_get_input_artifact_by_uid"
  end
  # verify the required parameter 'artifact_name' is set
  if @api_client.config.client_side_validation && artifact_name.nil?
    fail ArgumentError, "Missing the required parameter 'artifact_name' when calling ArtifactServiceApi.artifact_service_get_input_artifact_by_uid"
  end
  # resource path
  local_var_path = '/input-artifacts-by-uid/{uid}/{nodeId}/{artifactName}'.sub('{' + 'uid' + '}', uid.to_s).sub('{' + 'nodeId' + '}', node_id.to_s).sub('{' + 'artifactName' + '}', artifact_name.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # 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 = ['BearerToken']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'String')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ArtifactServiceApi#artifact_service_get_input_artifact_by_uid\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#artifact_service_get_input_artifact_with_http_info(namespace, name, node_id, artifact_name, opts = {}) ⇒ Array<(String, Fixnum, Hash)>

Get an input artifact.

Parameters:

  • namespace
  • name
  • node_id
  • artifact_name
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

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

    String data, response status code and response headers



131
132
133
134
135
136
137
138
139
140
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
180
181
 
# File 'lib/argo_workflows/api/artifact_service_api.rb', line 131

def artifact_service_get_input_artifact_with_http_info(namespace, name, node_id, artifact_name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ArtifactServiceApi.artifact_service_get_input_artifact ...'
  end
  # verify the required parameter 'namespace' is set
  if @api_client.config.client_side_validation && namespace.nil?
    fail ArgumentError, "Missing the required parameter 'namespace' when calling ArtifactServiceApi.artifact_service_get_input_artifact"
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling ArtifactServiceApi.artifact_service_get_input_artifact"
  end
  # verify the required parameter 'node_id' is set
  if @api_client.config.client_side_validation && node_id.nil?
    fail ArgumentError, "Missing the required parameter 'node_id' when calling ArtifactServiceApi.artifact_service_get_input_artifact"
  end
  # verify the required parameter 'artifact_name' is set
  if @api_client.config.client_side_validation && artifact_name.nil?
    fail ArgumentError, "Missing the required parameter 'artifact_name' when calling ArtifactServiceApi.artifact_service_get_input_artifact"
  end
  # resource path
  local_var_path = '/input-artifacts/{namespace}/{name}/{nodeId}/{artifactName}'.sub('{' + 'namespace' + '}', namespace.to_s).sub('{' + 'name' + '}', name.to_s).sub('{' + 'nodeId' + '}', node_id.to_s).sub('{' + 'artifactName' + '}', artifact_name.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # 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 = ['BearerToken']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'String')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ArtifactServiceApi#artifact_service_get_input_artifact\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#artifact_service_get_output_artifact(namespace, name, node_id, artifact_name, opts = {}) ⇒ String

Get an output artifact.

Parameters:

  • namespace
  • name
  • node_id
  • artifact_name
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (String) 


253
254
255
256
 
# File 'lib/argo_workflows/api/artifact_service_api.rb', line 253

def artifact_service_get_output_artifact(namespace, name, node_id, artifact_name, opts = {})
  data, _status_code, _headers = artifact_service_get_output_artifact_with_http_info(namespace, name, node_id, artifact_name, opts)
  data
end

#artifact_service_get_output_artifact_by_uid(uid, node_id, artifact_name, opts = {}) ⇒ String

Get an output artifact by UID.

Parameters:

  • uid
  • node_id
  • artifact_name
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (String) 


322
323
324
325
 
# File 'lib/argo_workflows/api/artifact_service_api.rb', line 322

def artifact_service_get_output_artifact_by_uid(uid, node_id, artifact_name, opts = {})
  data, _status_code, _headers = artifact_service_get_output_artifact_by_uid_with_http_info(uid, node_id, artifact_name, opts)
  data
end

#artifact_service_get_output_artifact_by_uid_with_http_info(uid, node_id, artifact_name, opts = {}) ⇒ Array<(String, Fixnum, Hash)>

Get an output artifact by UID.

Parameters:

  • uid
  • node_id
  • artifact_name
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

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

    String data, response status code and response headers



333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
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
 
# File 'lib/argo_workflows/api/artifact_service_api.rb', line 333

def artifact_service_get_output_artifact_by_uid_with_http_info(uid, node_id, artifact_name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ArtifactServiceApi.artifact_service_get_output_artifact_by_uid ...'
  end
  # verify the required parameter 'uid' is set
  if @api_client.config.client_side_validation && uid.nil?
    fail ArgumentError, "Missing the required parameter 'uid' when calling ArtifactServiceApi.artifact_service_get_output_artifact_by_uid"
  end
  # verify the required parameter 'node_id' is set
  if @api_client.config.client_side_validation && node_id.nil?
    fail ArgumentError, "Missing the required parameter 'node_id' when calling ArtifactServiceApi.artifact_service_get_output_artifact_by_uid"
  end
  # verify the required parameter 'artifact_name' is set
  if @api_client.config.client_side_validation && artifact_name.nil?
    fail ArgumentError, "Missing the required parameter 'artifact_name' when calling ArtifactServiceApi.artifact_service_get_output_artifact_by_uid"
  end
  # resource path
  local_var_path = '/artifacts-by-uid/{uid}/{nodeId}/{artifactName}'.sub('{' + 'uid' + '}', uid.to_s).sub('{' + 'nodeId' + '}', node_id.to_s).sub('{' + 'artifactName' + '}', artifact_name.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # 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 = ['BearerToken']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'String')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ArtifactServiceApi#artifact_service_get_output_artifact_by_uid\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#artifact_service_get_output_artifact_with_http_info(namespace, name, node_id, artifact_name, opts = {}) ⇒ Array<(String, Fixnum, Hash)>

Get an output artifact.

Parameters:

  • namespace
  • name
  • node_id
  • artifact_name
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

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

    String data, response status code and response headers



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
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
 
# File 'lib/argo_workflows/api/artifact_service_api.rb', line 265

def artifact_service_get_output_artifact_with_http_info(namespace, name, node_id, artifact_name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ArtifactServiceApi.artifact_service_get_output_artifact ...'
  end
  # verify the required parameter 'namespace' is set
  if @api_client.config.client_side_validation && namespace.nil?
    fail ArgumentError, "Missing the required parameter 'namespace' when calling ArtifactServiceApi.artifact_service_get_output_artifact"
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling ArtifactServiceApi.artifact_service_get_output_artifact"
  end
  # verify the required parameter 'node_id' is set
  if @api_client.config.client_side_validation && node_id.nil?
    fail ArgumentError, "Missing the required parameter 'node_id' when calling ArtifactServiceApi.artifact_service_get_output_artifact"
  end
  # verify the required parameter 'artifact_name' is set
  if @api_client.config.client_side_validation && artifact_name.nil?
    fail ArgumentError, "Missing the required parameter 'artifact_name' when calling ArtifactServiceApi.artifact_service_get_output_artifact"
  end
  # resource path
  local_var_path = '/artifacts/{namespace}/{name}/{nodeId}/{artifactName}'.sub('{' + 'namespace' + '}', namespace.to_s).sub('{' + 'name' + '}', name.to_s).sub('{' + 'nodeId' + '}', node_id.to_s).sub('{' + 'artifactName' + '}', artifact_name.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # 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 = ['BearerToken']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'String')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ArtifactServiceApi#artifact_service_get_output_artifact\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end