Class: HatchetSdkRest::WorkflowApi

Inherits:
Object
  • Object
show all
Defined in:
lib/hatchet/clients/rest/lib/hatchet-sdk-rest/api/workflow_api.rb,
sig/hatchet_sdk_rest.rbs

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ WorkflowApi

Returns a new instance of WorkflowApi.

Parameters:

  • (defaults to: ApiClient.default) 


19
20
21
 
# File 'lib/hatchet/clients/rest/lib/hatchet-sdk-rest/api/workflow_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/hatchet/clients/rest/lib/hatchet-sdk-rest/api/workflow_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#cron_workflow_list(tenant, opts = {}) ⇒ CronWorkflowsList

Get cron job workflows Get all cron job workflow triggers for a tenant

Parameters:

  • The tenant id

  • (defaults to: {})

    the optional parameters

Options Hash (opts):

  • :offset (Integer) —

    The number to skip

  • :limit (Integer) —

    The number to limit by

  • :workflow_id (String) —

    The workflow id to get runs for.

  • :workflow_name (String) —

    The workflow name to get runs for.

  • :cron_name (String) —

    The cron name to get runs for.

  • :additional_metadata (Array<String>) —

    A list of metadata key value pairs to filter by

  • :order_by_field (CronWorkflowsOrderByField) —

    The order by field

  • :order_by_direction (WorkflowRunOrderByDirection) —

    The order by direction

Returns:



35
36
37
38
 
# File 'lib/hatchet/clients/rest/lib/hatchet-sdk-rest/api/workflow_api.rb', line 35

def cron_workflow_list(tenant, opts = {})
  data, _status_code, _headers = cron_workflow_list_with_http_info(tenant, opts)
  data
end

#cron_workflow_list_with_http_info(tenant, opts = {}) ⇒ Array<(CronWorkflowsList, Integer, Hash)>

Get cron job workflows Get all cron job workflow triggers for a tenant

Parameters:

  • The tenant id

  • (defaults to: {})

    the optional parameters

Options Hash (opts):

  • :offset (Integer) —

    The number to skip

  • :limit (Integer) —

    The number to limit by

  • :workflow_id (String) —

    The workflow id to get runs for.

  • :workflow_name (String) —

    The workflow name to get runs for.

  • :cron_name (String) —

    The cron name to get runs for.

  • :additional_metadata (Array<String>) —

    A list of metadata key value pairs to filter by

  • :order_by_field (CronWorkflowsOrderByField) —

    The order by field

  • :order_by_direction (WorkflowRunOrderByDirection) —

    The order by direction

Returns:

  • CronWorkflowsList data, response status code and response headers



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
112
113
114
115
116
117
118
119
120
121
122
123
 
# File 'lib/hatchet/clients/rest/lib/hatchet-sdk-rest/api/workflow_api.rb', line 53

def cron_workflow_list_with_http_info(tenant, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WorkflowApi.cron_workflow_list ...'
  end
  # verify the required parameter 'tenant' is set
  if @api_client.config.client_side_validation && tenant.nil?
    fail ArgumentError, "Missing the required parameter 'tenant' when calling WorkflowApi.cron_workflow_list"
  end
  if @api_client.config.client_side_validation && tenant.to_s.length > 36
    fail ArgumentError, 'invalid value for "tenant" when calling WorkflowApi.cron_workflow_list, the character length must be smaller than or equal to 36.'
  end

  if @api_client.config.client_side_validation && tenant.to_s.length < 36
    fail ArgumentError, 'invalid value for "tenant" when calling WorkflowApi.cron_workflow_list, the character length must be greater than or equal to 36.'
  end

  if @api_client.config.client_side_validation && !opts[:'workflow_id'].nil? && opts[:'workflow_id'].to_s.length > 36
    fail ArgumentError, 'invalid value for "opts[:"workflow_id"]" when calling WorkflowApi.cron_workflow_list, the character length must be smaller than or equal to 36.'
  end

  if @api_client.config.client_side_validation && !opts[:'workflow_id'].nil? && opts[:'workflow_id'].to_s.length < 36
    fail ArgumentError, 'invalid value for "opts[:"workflow_id"]" when calling WorkflowApi.cron_workflow_list, the character length must be greater than or equal to 36.'
  end

  # resource path
  local_var_path = '/api/v1/tenants/{tenant}/workflows/crons'.sub('{' + 'tenant' + '}', CGI.escape(tenant.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'workflowId'] = opts[:'workflow_id'] if !opts[:'workflow_id'].nil?
  query_params[:'workflowName'] = opts[:'workflow_name'] if !opts[:'workflow_name'].nil?
  query_params[:'cronName'] = opts[:'cron_name'] if !opts[:'cron_name'].nil?
  query_params[:'additionalMetadata'] = @api_client.build_collection_param(opts[:'additional_metadata'], :multi) if !opts[:'additional_metadata'].nil?
  query_params[:'orderByField'] = opts[:'order_by_field'] if !opts[:'order_by_field'].nil?
  query_params[:'orderByDirection'] = opts[:'order_by_direction'] if !opts[:'order_by_direction'].nil?

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

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

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

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['cookieAuth', 'bearerAuth']

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

#tenant_get_queue_metrics(tenant, opts = {}) ⇒ TenantQueueMetrics

Get workflow metrics Get the queue metrics for the tenant

Parameters:

  • The tenant id

  • (defaults to: {})

    the optional parameters

Options Hash (opts):

  • :workflows (Array<String>) —

    A list of workflow IDs to filter by

  • :additional_metadata (Array<String>) —

    A list of metadata key value pairs to filter by

Returns:



132
133
134
135
 
# File 'lib/hatchet/clients/rest/lib/hatchet-sdk-rest/api/workflow_api.rb', line 132

def tenant_get_queue_metrics(tenant, opts = {})
  data, _status_code, _headers = tenant_get_queue_metrics_with_http_info(tenant, opts)
  data
end

#tenant_get_queue_metrics_with_http_info(tenant, opts = {}) ⇒ Array<(TenantQueueMetrics, Integer, Hash)>

Get workflow metrics Get the queue metrics for the tenant

Parameters:

  • The tenant id

  • (defaults to: {})

    the optional parameters

Options Hash (opts):

  • :workflows (Array<String>) —

    A list of workflow IDs to filter by

  • :additional_metadata (Array<String>) —

    A list of metadata key value pairs to filter by

Returns:

  • TenantQueueMetrics data, response status code and response headers



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
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
 
# File 'lib/hatchet/clients/rest/lib/hatchet-sdk-rest/api/workflow_api.rb', line 144

def tenant_get_queue_metrics_with_http_info(tenant, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WorkflowApi.tenant_get_queue_metrics ...'
  end
  # verify the required parameter 'tenant' is set
  if @api_client.config.client_side_validation && tenant.nil?
    fail ArgumentError, "Missing the required parameter 'tenant' when calling WorkflowApi.tenant_get_queue_metrics"
  end
  if @api_client.config.client_side_validation && tenant.to_s.length > 36
    fail ArgumentError, 'invalid value for "tenant" when calling WorkflowApi.tenant_get_queue_metrics, the character length must be smaller than or equal to 36.'
  end

  if @api_client.config.client_side_validation && tenant.to_s.length < 36
    fail ArgumentError, 'invalid value for "tenant" when calling WorkflowApi.tenant_get_queue_metrics, the character length must be greater than or equal to 36.'
  end

  # resource path
  local_var_path = '/api/v1/tenants/{tenant}/queue-metrics'.sub('{' + 'tenant' + '}', CGI.escape(tenant.to_s))

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

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

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

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

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['cookieAuth', 'bearerAuth']

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

#workflow_cron_delete(tenant, cron_workflow, opts = {}) ⇒ nil

Delete cron job workflow run Delete a cron job workflow run for a tenant

Parameters:

  • The tenant id

  • The cron job id

  • (defaults to: {})

    the optional parameters

Returns:



208
209
210
211
 
# File 'lib/hatchet/clients/rest/lib/hatchet-sdk-rest/api/workflow_api.rb', line 208

def workflow_cron_delete(tenant, cron_workflow, opts = {})
  workflow_cron_delete_with_http_info(tenant, cron_workflow, opts)
  nil
end

#workflow_cron_delete_with_http_info(tenant, cron_workflow, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete cron job workflow run Delete a cron job workflow run for a tenant

Parameters:

  • The tenant id

  • The cron job id

  • (defaults to: {})

    the optional parameters

Returns:

  • nil, response status code and response headers



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
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
275
276
277
278
279
280
281
282
283
284
285
 
# File 'lib/hatchet/clients/rest/lib/hatchet-sdk-rest/api/workflow_api.rb', line 219

def workflow_cron_delete_with_http_info(tenant, cron_workflow, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WorkflowApi.workflow_cron_delete ...'
  end
  # verify the required parameter 'tenant' is set
  if @api_client.config.client_side_validation && tenant.nil?
    fail ArgumentError, "Missing the required parameter 'tenant' when calling WorkflowApi.workflow_cron_delete"
  end
  if @api_client.config.client_side_validation && tenant.to_s.length > 36
    fail ArgumentError, 'invalid value for "tenant" when calling WorkflowApi.workflow_cron_delete, the character length must be smaller than or equal to 36.'
  end

  if @api_client.config.client_side_validation && tenant.to_s.length < 36
    fail ArgumentError, 'invalid value for "tenant" when calling WorkflowApi.workflow_cron_delete, the character length must be greater than or equal to 36.'
  end

  # verify the required parameter 'cron_workflow' is set
  if @api_client.config.client_side_validation && cron_workflow.nil?
    fail ArgumentError, "Missing the required parameter 'cron_workflow' when calling WorkflowApi.workflow_cron_delete"
  end
  if @api_client.config.client_side_validation && cron_workflow.to_s.length > 36
    fail ArgumentError, 'invalid value for "cron_workflow" when calling WorkflowApi.workflow_cron_delete, the character length must be smaller than or equal to 36.'
  end

  if @api_client.config.client_side_validation && cron_workflow.to_s.length < 36
    fail ArgumentError, 'invalid value for "cron_workflow" when calling WorkflowApi.workflow_cron_delete, the character length must be greater than or equal to 36.'
  end

  # resource path
  local_var_path = '/api/v1/tenants/{tenant}/workflows/crons/{cron-workflow}'.sub('{' + 'tenant' + '}', CGI.escape(tenant.to_s)).sub('{' + 'cron-workflow' + '}', CGI.escape(cron_workflow.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']) unless header_params['Accept']

  # 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] || ['cookieAuth', 'bearerAuth']

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

#workflow_cron_get(tenant, cron_workflow, opts = {}) ⇒ CronWorkflows

Get cron job workflow run Get a cron job workflow run for a tenant

Parameters:

  • The tenant id

  • The cron job id

  • (defaults to: {})

    the optional parameters

Returns:



293
294
295
296
 
# File 'lib/hatchet/clients/rest/lib/hatchet-sdk-rest/api/workflow_api.rb', line 293

def workflow_cron_get(tenant, cron_workflow, opts = {})
  data, _status_code, _headers = workflow_cron_get_with_http_info(tenant, cron_workflow, opts)
  data
end

#workflow_cron_get_with_http_info(tenant, cron_workflow, opts = {}) ⇒ Array<(CronWorkflows, Integer, Hash)>

Get cron job workflow run Get a cron job workflow run for a tenant

Parameters:

  • The tenant id

  • The cron job id

  • (defaults to: {})

    the optional parameters

Returns:

  • CronWorkflows data, response status code and response headers



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
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
 
# File 'lib/hatchet/clients/rest/lib/hatchet-sdk-rest/api/workflow_api.rb', line 304

def workflow_cron_get_with_http_info(tenant, cron_workflow, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WorkflowApi.workflow_cron_get ...'
  end
  # verify the required parameter 'tenant' is set
  if @api_client.config.client_side_validation && tenant.nil?
    fail ArgumentError, "Missing the required parameter 'tenant' when calling WorkflowApi.workflow_cron_get"
  end
  if @api_client.config.client_side_validation && tenant.to_s.length > 36
    fail ArgumentError, 'invalid value for "tenant" when calling WorkflowApi.workflow_cron_get, the character length must be smaller than or equal to 36.'
  end

  if @api_client.config.client_side_validation && tenant.to_s.length < 36
    fail ArgumentError, 'invalid value for "tenant" when calling WorkflowApi.workflow_cron_get, the character length must be greater than or equal to 36.'
  end

  # verify the required parameter 'cron_workflow' is set
  if @api_client.config.client_side_validation && cron_workflow.nil?
    fail ArgumentError, "Missing the required parameter 'cron_workflow' when calling WorkflowApi.workflow_cron_get"
  end
  if @api_client.config.client_side_validation && cron_workflow.to_s.length > 36
    fail ArgumentError, 'invalid value for "cron_workflow" when calling WorkflowApi.workflow_cron_get, the character length must be smaller than or equal to 36.'
  end

  if @api_client.config.client_side_validation && cron_workflow.to_s.length < 36
    fail ArgumentError, 'invalid value for "cron_workflow" when calling WorkflowApi.workflow_cron_get, the character length must be greater than or equal to 36.'
  end

  # resource path
  local_var_path = '/api/v1/tenants/{tenant}/workflows/crons/{cron-workflow}'.sub('{' + 'tenant' + '}', CGI.escape(tenant.to_s)).sub('{' + 'cron-workflow' + '}', CGI.escape(cron_workflow.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']) unless header_params['Accept']

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

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

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['cookieAuth', 'bearerAuth']

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

#workflow_cron_trigger(tenant, cron_workflow, opts = {}) ⇒ TriggerRunResult

Trigger cron job workflow run immediately Trigger a cron workflow immediately for a tenant

Parameters:

  • The tenant id

  • The cron job id

  • (defaults to: {})

    the optional parameters

Returns:



378
379
380
381
 
# File 'lib/hatchet/clients/rest/lib/hatchet-sdk-rest/api/workflow_api.rb', line 378

def workflow_cron_trigger(tenant, cron_workflow, opts = {})
  data, _status_code, _headers = workflow_cron_trigger_with_http_info(tenant, cron_workflow, opts)
  data
end

#workflow_cron_trigger_with_http_info(tenant, cron_workflow, opts = {}) ⇒ Array<(TriggerRunResult, Integer, Hash)>

Trigger cron job workflow run immediately Trigger a cron workflow immediately for a tenant

Parameters:

  • The tenant id

  • The cron job id

  • (defaults to: {})

    the optional parameters

Returns:

  • TriggerRunResult data, response status code and response headers



389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
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
452
453
454
455
 
# File 'lib/hatchet/clients/rest/lib/hatchet-sdk-rest/api/workflow_api.rb', line 389

def workflow_cron_trigger_with_http_info(tenant, cron_workflow, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WorkflowApi.workflow_cron_trigger ...'
  end
  # verify the required parameter 'tenant' is set
  if @api_client.config.client_side_validation && tenant.nil?
    fail ArgumentError, "Missing the required parameter 'tenant' when calling WorkflowApi.workflow_cron_trigger"
  end
  if @api_client.config.client_side_validation && tenant.to_s.length > 36
    fail ArgumentError, 'invalid value for "tenant" when calling WorkflowApi.workflow_cron_trigger, the character length must be smaller than or equal to 36.'
  end

  if @api_client.config.client_side_validation && tenant.to_s.length < 36
    fail ArgumentError, 'invalid value for "tenant" when calling WorkflowApi.workflow_cron_trigger, the character length must be greater than or equal to 36.'
  end

  # verify the required parameter 'cron_workflow' is set
  if @api_client.config.client_side_validation && cron_workflow.nil?
    fail ArgumentError, "Missing the required parameter 'cron_workflow' when calling WorkflowApi.workflow_cron_trigger"
  end
  if @api_client.config.client_side_validation && cron_workflow.to_s.length > 36
    fail ArgumentError, 'invalid value for "cron_workflow" when calling WorkflowApi.workflow_cron_trigger, the character length must be smaller than or equal to 36.'
  end

  if @api_client.config.client_side_validation && cron_workflow.to_s.length < 36
    fail ArgumentError, 'invalid value for "cron_workflow" when calling WorkflowApi.workflow_cron_trigger, the character length must be greater than or equal to 36.'
  end

  # resource path
  local_var_path = '/api/v1/tenants/{tenant}/workflows/crons/{cron-workflow}'.sub('{' + 'tenant' + '}', CGI.escape(tenant.to_s)).sub('{' + 'cron-workflow' + '}', CGI.escape(cron_workflow.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']) unless header_params['Accept']

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

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

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['cookieAuth', 'bearerAuth']

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

#workflow_cron_update(tenant, cron_workflow, update_cron_workflow_trigger_request, opts = {}) ⇒ nil

Update cron job workflow run Update a cron workflow for a tenant

Parameters:

  • The tenant id

  • The cron job id

  • The input for updates

  • (defaults to: {})

    the optional parameters

Returns:



464
465
466
467
 
# File 'lib/hatchet/clients/rest/lib/hatchet-sdk-rest/api/workflow_api.rb', line 464

def workflow_cron_update(tenant, cron_workflow, update_cron_workflow_trigger_request, opts = {})
  workflow_cron_update_with_http_info(tenant, cron_workflow, update_cron_workflow_trigger_request, opts)
  nil
end

#workflow_cron_update_with_http_info(tenant, cron_workflow, update_cron_workflow_trigger_request, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Update cron job workflow run Update a cron workflow for a tenant

Parameters:

  • The tenant id

  • The cron job id

  • The input for updates

  • (defaults to: {})

    the optional parameters

Returns:

  • nil, response status code and response headers



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
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
 
# File 'lib/hatchet/clients/rest/lib/hatchet-sdk-rest/api/workflow_api.rb', line 476

def workflow_cron_update_with_http_info(tenant, cron_workflow, update_cron_workflow_trigger_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WorkflowApi.workflow_cron_update ...'
  end
  # verify the required parameter 'tenant' is set
  if @api_client.config.client_side_validation && tenant.nil?
    fail ArgumentError, "Missing the required parameter 'tenant' when calling WorkflowApi.workflow_cron_update"
  end
  if @api_client.config.client_side_validation && tenant.to_s.length > 36
    fail ArgumentError, 'invalid value for "tenant" when calling WorkflowApi.workflow_cron_update, the character length must be smaller than or equal to 36.'
  end

  if @api_client.config.client_side_validation && tenant.to_s.length < 36
    fail ArgumentError, 'invalid value for "tenant" when calling WorkflowApi.workflow_cron_update, the character length must be greater than or equal to 36.'
  end

  # verify the required parameter 'cron_workflow' is set
  if @api_client.config.client_side_validation && cron_workflow.nil?
    fail ArgumentError, "Missing the required parameter 'cron_workflow' when calling WorkflowApi.workflow_cron_update"
  end
  if @api_client.config.client_side_validation && cron_workflow.to_s.length > 36
    fail ArgumentError, 'invalid value for "cron_workflow" when calling WorkflowApi.workflow_cron_update, the character length must be smaller than or equal to 36.'
  end

  if @api_client.config.client_side_validation && cron_workflow.to_s.length < 36
    fail ArgumentError, 'invalid value for "cron_workflow" when calling WorkflowApi.workflow_cron_update, the character length must be greater than or equal to 36.'
  end

  # verify the required parameter 'update_cron_workflow_trigger_request' is set
  if @api_client.config.client_side_validation && update_cron_workflow_trigger_request.nil?
    fail ArgumentError, "Missing the required parameter 'update_cron_workflow_trigger_request' when calling WorkflowApi.workflow_cron_update"
  end
  # resource path
  local_var_path = '/api/v1/tenants/{tenant}/workflows/crons/{cron-workflow}'.sub('{' + 'tenant' + '}', CGI.escape(tenant.to_s)).sub('{' + 'cron-workflow' + '}', CGI.escape(cron_workflow.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']) unless header_params['Accept']
  # 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(update_cron_workflow_trigger_request)

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || ['cookieAuth', 'bearerAuth']

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

#workflow_delete(workflow, opts = {}) ⇒ nil

Delete workflow Delete a workflow for a tenant

Parameters:

  • The workflow id

  • (defaults to: {})

    the optional parameters

Returns:



558
559
560
561
 
# File 'lib/hatchet/clients/rest/lib/hatchet-sdk-rest/api/workflow_api.rb', line 558

def workflow_delete(workflow, opts = {})
  workflow_delete_with_http_info(workflow, opts)
  nil
end

#workflow_delete_with_http_info(workflow, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete workflow Delete a workflow for a tenant

Parameters:

  • The workflow id

  • (defaults to: {})

    the optional parameters

Returns:

  • nil, response status code and response headers



568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
 
# File 'lib/hatchet/clients/rest/lib/hatchet-sdk-rest/api/workflow_api.rb', line 568

def workflow_delete_with_http_info(workflow, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WorkflowApi.workflow_delete ...'
  end
  # verify the required parameter 'workflow' is set
  if @api_client.config.client_side_validation && workflow.nil?
    fail ArgumentError, "Missing the required parameter 'workflow' when calling WorkflowApi.workflow_delete"
  end
  if @api_client.config.client_side_validation && workflow.to_s.length > 36
    fail ArgumentError, 'invalid value for "workflow" when calling WorkflowApi.workflow_delete, the character length must be smaller than or equal to 36.'
  end

  if @api_client.config.client_side_validation && workflow.to_s.length < 36
    fail ArgumentError, 'invalid value for "workflow" when calling WorkflowApi.workflow_delete, the character length must be greater than or equal to 36.'
  end

  # resource path
  local_var_path = '/api/v1/workflows/{workflow}'.sub('{' + 'workflow' + '}', CGI.escape(workflow.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']) unless header_params['Accept']

  # 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] || ['cookieAuth', 'bearerAuth']

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

#workflow_get(workflow, opts = {}) ⇒ Workflow

Get workflow Get a workflow for a tenant

Parameters:

  • The workflow id

  • (defaults to: {})

    the optional parameters

Returns:



629
630
631
632
 
# File 'lib/hatchet/clients/rest/lib/hatchet-sdk-rest/api/workflow_api.rb', line 629

def workflow_get(workflow, opts = {})
  data, _status_code, _headers = workflow_get_with_http_info(workflow, opts)
  data
end

#workflow_get_metrics(workflow, opts = {}) ⇒ WorkflowMetrics

Get workflow metrics Get the metrics for a workflow version

Parameters:

  • The workflow id

  • (defaults to: {})

    the optional parameters

Options Hash (opts):

  • :status (WorkflowRunStatus) —

    A status of workflow run statuses to filter by

  • :group_key (String) —

    A group key to filter metrics by

Returns:



702
703
704
705
 
# File 'lib/hatchet/clients/rest/lib/hatchet-sdk-rest/api/workflow_api.rb', line 702

def workflow_get_metrics(workflow, opts = {})
  data, _status_code, _headers = workflow_get_metrics_with_http_info(workflow, opts)
  data
end

#workflow_get_metrics_with_http_info(workflow, opts = {}) ⇒ Array<(WorkflowMetrics, Integer, Hash)>

Get workflow metrics Get the metrics for a workflow version

Parameters:

  • The workflow id

  • (defaults to: {})

    the optional parameters

Options Hash (opts):

  • :status (WorkflowRunStatus) —

    A status of workflow run statuses to filter by

  • :group_key (String) —

    A group key to filter metrics by

Returns:

  • WorkflowMetrics data, response status code and response headers



714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
 
# File 'lib/hatchet/clients/rest/lib/hatchet-sdk-rest/api/workflow_api.rb', line 714

def workflow_get_metrics_with_http_info(workflow, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WorkflowApi.workflow_get_metrics ...'
  end
  # verify the required parameter 'workflow' is set
  if @api_client.config.client_side_validation && workflow.nil?
    fail ArgumentError, "Missing the required parameter 'workflow' when calling WorkflowApi.workflow_get_metrics"
  end
  if @api_client.config.client_side_validation && workflow.to_s.length > 36
    fail ArgumentError, 'invalid value for "workflow" when calling WorkflowApi.workflow_get_metrics, the character length must be smaller than or equal to 36.'
  end

  if @api_client.config.client_side_validation && workflow.to_s.length < 36
    fail ArgumentError, 'invalid value for "workflow" when calling WorkflowApi.workflow_get_metrics, the character length must be greater than or equal to 36.'
  end

  # resource path
  local_var_path = '/api/v1/workflows/{workflow}/metrics'.sub('{' + 'workflow' + '}', CGI.escape(workflow.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'status'] = opts[:'status'] if !opts[:'status'].nil?
  query_params[:'groupKey'] = opts[:'group_key'] if !opts[:'group_key'].nil?

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

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

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

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['cookieAuth', 'bearerAuth']

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

#workflow_get_with_http_info(workflow, opts = {}) ⇒ Array<(Workflow, Integer, Hash)>

Get workflow Get a workflow for a tenant

Parameters:

  • The workflow id

  • (defaults to: {})

    the optional parameters

Returns:

  • Workflow data, response status code and response headers



639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
 
# File 'lib/hatchet/clients/rest/lib/hatchet-sdk-rest/api/workflow_api.rb', line 639

def workflow_get_with_http_info(workflow, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WorkflowApi.workflow_get ...'
  end
  # verify the required parameter 'workflow' is set
  if @api_client.config.client_side_validation && workflow.nil?
    fail ArgumentError, "Missing the required parameter 'workflow' when calling WorkflowApi.workflow_get"
  end
  if @api_client.config.client_side_validation && workflow.to_s.length > 36
    fail ArgumentError, 'invalid value for "workflow" when calling WorkflowApi.workflow_get, the character length must be smaller than or equal to 36.'
  end

  if @api_client.config.client_side_validation && workflow.to_s.length < 36
    fail ArgumentError, 'invalid value for "workflow" when calling WorkflowApi.workflow_get, the character length must be greater than or equal to 36.'
  end

  # resource path
  local_var_path = '/api/v1/workflows/{workflow}'.sub('{' + 'workflow' + '}', CGI.escape(workflow.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']) unless header_params['Accept']

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

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

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['cookieAuth', 'bearerAuth']

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

#workflow_get_workers_count(tenant, workflow, opts = {}) ⇒ WorkflowWorkersCount

Get workflow worker count Get a count of the workers available for workflow

Parameters:

  • The tenant id

  • The workflow id

  • (defaults to: {})

    the optional parameters

Returns:



778
779
780
781
 
# File 'lib/hatchet/clients/rest/lib/hatchet-sdk-rest/api/workflow_api.rb', line 778

def workflow_get_workers_count(tenant, workflow, opts = {})
  data, _status_code, _headers = workflow_get_workers_count_with_http_info(tenant, workflow, opts)
  data
end

#workflow_get_workers_count_with_http_info(tenant, workflow, opts = {}) ⇒ Array<(WorkflowWorkersCount, Integer, Hash)>

Get workflow worker count Get a count of the workers available for workflow

Parameters:

  • The tenant id

  • The workflow id

  • (defaults to: {})

    the optional parameters

Returns:

  • WorkflowWorkersCount data, response status code and response headers



789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
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
 
# File 'lib/hatchet/clients/rest/lib/hatchet-sdk-rest/api/workflow_api.rb', line 789

def workflow_get_workers_count_with_http_info(tenant, workflow, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WorkflowApi.workflow_get_workers_count ...'
  end
  # verify the required parameter 'tenant' is set
  if @api_client.config.client_side_validation && tenant.nil?
    fail ArgumentError, "Missing the required parameter 'tenant' when calling WorkflowApi.workflow_get_workers_count"
  end
  if @api_client.config.client_side_validation && tenant.to_s.length > 36
    fail ArgumentError, 'invalid value for "tenant" when calling WorkflowApi.workflow_get_workers_count, the character length must be smaller than or equal to 36.'
  end

  if @api_client.config.client_side_validation && tenant.to_s.length < 36
    fail ArgumentError, 'invalid value for "tenant" when calling WorkflowApi.workflow_get_workers_count, the character length must be greater than or equal to 36.'
  end

  # verify the required parameter 'workflow' is set
  if @api_client.config.client_side_validation && workflow.nil?
    fail ArgumentError, "Missing the required parameter 'workflow' when calling WorkflowApi.workflow_get_workers_count"
  end
  if @api_client.config.client_side_validation && workflow.to_s.length > 36
    fail ArgumentError, 'invalid value for "workflow" when calling WorkflowApi.workflow_get_workers_count, the character length must be smaller than or equal to 36.'
  end

  if @api_client.config.client_side_validation && workflow.to_s.length < 36
    fail ArgumentError, 'invalid value for "workflow" when calling WorkflowApi.workflow_get_workers_count, the character length must be greater than or equal to 36.'
  end

  # resource path
  local_var_path = '/api/v1/tenants/{tenant}/workflows/{workflow}/worker-count'.sub('{' + 'tenant' + '}', CGI.escape(tenant.to_s)).sub('{' + 'workflow' + '}', CGI.escape(workflow.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']) unless header_params['Accept']

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

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

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['cookieAuth', 'bearerAuth']

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

#workflow_list(tenant, opts = {}) ⇒ WorkflowList

Get workflows Get all workflows for a tenant

Parameters:

  • The tenant id

  • (defaults to: {})

    the optional parameters

Options Hash (opts):

  • :offset (Integer) —

    The number to skip (default to 0)

  • :limit (Integer) —

    The number to limit by (default to 50)

  • :name (String) —

    Search by name

Returns:



865
866
867
868
 
# File 'lib/hatchet/clients/rest/lib/hatchet-sdk-rest/api/workflow_api.rb', line 865

def workflow_list(tenant, opts = {})
  data, _status_code, _headers = workflow_list_with_http_info(tenant, opts)
  data
end

#workflow_list_with_http_info(tenant, opts = {}) ⇒ Array<(WorkflowList, Integer, Hash)>

Get workflows Get all workflows for a tenant

Parameters:

  • The tenant id

  • (defaults to: {})

    the optional parameters

Options Hash (opts):

  • :offset (Integer) —

    The number to skip (default to 0)

  • :limit (Integer) —

    The number to limit by (default to 50)

  • :name (String) —

    Search by name

Returns:

  • WorkflowList data, response status code and response headers



878
879
880
881
882
883
884
885
886
887
888
889
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
 
# File 'lib/hatchet/clients/rest/lib/hatchet-sdk-rest/api/workflow_api.rb', line 878

def workflow_list_with_http_info(tenant, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WorkflowApi.workflow_list ...'
  end
  # verify the required parameter 'tenant' is set
  if @api_client.config.client_side_validation && tenant.nil?
    fail ArgumentError, "Missing the required parameter 'tenant' when calling WorkflowApi.workflow_list"
  end
  if @api_client.config.client_side_validation && tenant.to_s.length > 36
    fail ArgumentError, 'invalid value for "tenant" when calling WorkflowApi.workflow_list, the character length must be smaller than or equal to 36.'
  end

  if @api_client.config.client_side_validation && tenant.to_s.length < 36
    fail ArgumentError, 'invalid value for "tenant" when calling WorkflowApi.workflow_list, the character length must be greater than or equal to 36.'
  end

  # resource path
  local_var_path = '/api/v1/tenants/{tenant}/workflows'.sub('{' + 'tenant' + '}', CGI.escape(tenant.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'name'] = opts[:'name'] if !opts[:'name'].nil?

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

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

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

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['cookieAuth', 'bearerAuth']

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

#workflow_run_get(tenant, workflow_run, opts = {}) ⇒ WorkflowRun

Get workflow run Get a workflow run for a tenant

Parameters:

  • The tenant id

  • The workflow run id

  • (defaults to: {})

    the optional parameters

Returns:



943
944
945
946
 
# File 'lib/hatchet/clients/rest/lib/hatchet-sdk-rest/api/workflow_api.rb', line 943

def workflow_run_get(tenant, workflow_run, opts = {})
  data, _status_code, _headers = workflow_run_get_with_http_info(tenant, workflow_run, opts)
  data
end

#workflow_run_get_metrics(tenant, opts = {}) ⇒ WorkflowRunsMetrics

Get workflow runs metrics Get a summary of workflow run metrics for a tenant

Parameters:

  • The tenant id

  • (defaults to: {})

    the optional parameters

Options Hash (opts):

  • :event_id (String) —

    The event id to get runs for.

  • :workflow_id (String) —

    The workflow id to get runs for.

  • :parent_workflow_run_id (String) —

    The parent workflow run id

  • :parent_step_run_id (String) —

    The parent step run id

  • :additional_metadata (Array<String>) —

    A list of metadata key value pairs to filter by

  • :created_after (Time) —

    The time after the workflow run was created

  • :created_before (Time) —

    The time before the workflow run was created

Returns:



1034
1035
1036
1037
 
# File 'lib/hatchet/clients/rest/lib/hatchet-sdk-rest/api/workflow_api.rb', line 1034

def workflow_run_get_metrics(tenant, opts = {})
  data, _status_code, _headers = workflow_run_get_metrics_with_http_info(tenant, opts)
  data
end

#workflow_run_get_metrics_with_http_info(tenant, opts = {}) ⇒ Array<(WorkflowRunsMetrics, Integer, Hash)>

Get workflow runs metrics Get a summary of workflow run metrics for a tenant

Parameters:

  • The tenant id

  • (defaults to: {})

    the optional parameters

Options Hash (opts):

  • :event_id (String) —

    The event id to get runs for.

  • :workflow_id (String) —

    The workflow id to get runs for.

  • :parent_workflow_run_id (String) —

    The parent workflow run id

  • :parent_step_run_id (String) —

    The parent step run id

  • :additional_metadata (Array<String>) —

    A list of metadata key value pairs to filter by

  • :created_after (Time) —

    The time after the workflow run was created

  • :created_before (Time) —

    The time before the workflow run was created

Returns:

  • WorkflowRunsMetrics data, response status code and response headers



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
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
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
 
# File 'lib/hatchet/clients/rest/lib/hatchet-sdk-rest/api/workflow_api.rb', line 1051

def workflow_run_get_metrics_with_http_info(tenant, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WorkflowApi.workflow_run_get_metrics ...'
  end
  # verify the required parameter 'tenant' is set
  if @api_client.config.client_side_validation && tenant.nil?
    fail ArgumentError, "Missing the required parameter 'tenant' when calling WorkflowApi.workflow_run_get_metrics"
  end
  if @api_client.config.client_side_validation && tenant.to_s.length > 36
    fail ArgumentError, 'invalid value for "tenant" when calling WorkflowApi.workflow_run_get_metrics, the character length must be smaller than or equal to 36.'
  end

  if @api_client.config.client_side_validation && tenant.to_s.length < 36
    fail ArgumentError, 'invalid value for "tenant" when calling WorkflowApi.workflow_run_get_metrics, the character length must be greater than or equal to 36.'
  end

  if @api_client.config.client_side_validation && !opts[:'event_id'].nil? && opts[:'event_id'].to_s.length > 36
    fail ArgumentError, 'invalid value for "opts[:"event_id"]" when calling WorkflowApi.workflow_run_get_metrics, the character length must be smaller than or equal to 36.'
  end

  if @api_client.config.client_side_validation && !opts[:'event_id'].nil? && opts[:'event_id'].to_s.length < 36
    fail ArgumentError, 'invalid value for "opts[:"event_id"]" when calling WorkflowApi.workflow_run_get_metrics, the character length must be greater than or equal to 36.'
  end

  if @api_client.config.client_side_validation && !opts[:'workflow_id'].nil? && opts[:'workflow_id'].to_s.length > 36
    fail ArgumentError, 'invalid value for "opts[:"workflow_id"]" when calling WorkflowApi.workflow_run_get_metrics, the character length must be smaller than or equal to 36.'
  end

  if @api_client.config.client_side_validation && !opts[:'workflow_id'].nil? && opts[:'workflow_id'].to_s.length < 36
    fail ArgumentError, 'invalid value for "opts[:"workflow_id"]" when calling WorkflowApi.workflow_run_get_metrics, the character length must be greater than or equal to 36.'
  end

  if @api_client.config.client_side_validation && !opts[:'parent_workflow_run_id'].nil? && opts[:'parent_workflow_run_id'].to_s.length > 36
    fail ArgumentError, 'invalid value for "opts[:"parent_workflow_run_id"]" when calling WorkflowApi.workflow_run_get_metrics, the character length must be smaller than or equal to 36.'
  end

  if @api_client.config.client_side_validation && !opts[:'parent_workflow_run_id'].nil? && opts[:'parent_workflow_run_id'].to_s.length < 36
    fail ArgumentError, 'invalid value for "opts[:"parent_workflow_run_id"]" when calling WorkflowApi.workflow_run_get_metrics, the character length must be greater than or equal to 36.'
  end

  if @api_client.config.client_side_validation && !opts[:'parent_step_run_id'].nil? && opts[:'parent_step_run_id'].to_s.length > 36
    fail ArgumentError, 'invalid value for "opts[:"parent_step_run_id"]" when calling WorkflowApi.workflow_run_get_metrics, the character length must be smaller than or equal to 36.'
  end

  if @api_client.config.client_side_validation && !opts[:'parent_step_run_id'].nil? && opts[:'parent_step_run_id'].to_s.length < 36
    fail ArgumentError, 'invalid value for "opts[:"parent_step_run_id"]" when calling WorkflowApi.workflow_run_get_metrics, the character length must be greater than or equal to 36.'
  end

  # resource path
  local_var_path = '/api/v1/tenants/{tenant}/workflows/runs/metrics'.sub('{' + 'tenant' + '}', CGI.escape(tenant.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'eventId'] = opts[:'event_id'] if !opts[:'event_id'].nil?
  query_params[:'workflowId'] = opts[:'workflow_id'] if !opts[:'workflow_id'].nil?
  query_params[:'parentWorkflowRunId'] = opts[:'parent_workflow_run_id'] if !opts[:'parent_workflow_run_id'].nil?
  query_params[:'parentStepRunId'] = opts[:'parent_step_run_id'] if !opts[:'parent_step_run_id'].nil?
  query_params[:'additionalMetadata'] = @api_client.build_collection_param(opts[:'additional_metadata'], :multi) if !opts[:'additional_metadata'].nil?
  query_params[:'createdAfter'] = opts[:'created_after'] if !opts[:'created_after'].nil?
  query_params[:'createdBefore'] = opts[:'created_before'] if !opts[:'created_before'].nil?

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

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

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

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['cookieAuth', 'bearerAuth']

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

#workflow_run_get_shape(tenant, workflow_run, opts = {}) ⇒ WorkflowRunShape

Get workflow run Get a workflow run for a tenant

Parameters:

  • The tenant id

  • The workflow run id

  • (defaults to: {})

    the optional parameters

Returns:



1152
1153
1154
1155
 
# File 'lib/hatchet/clients/rest/lib/hatchet-sdk-rest/api/workflow_api.rb', line 1152

def workflow_run_get_shape(tenant, workflow_run, opts = {})
  data, _status_code, _headers = workflow_run_get_shape_with_http_info(tenant, workflow_run, opts)
  data
end

#workflow_run_get_shape_with_http_info(tenant, workflow_run, opts = {}) ⇒ Array<(WorkflowRunShape, Integer, Hash)>

Get workflow run Get a workflow run for a tenant

Parameters:

  • The tenant id

  • The workflow run id

  • (defaults to: {})

    the optional parameters

Returns:

  • WorkflowRunShape data, response status code and response headers



1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
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
 
# File 'lib/hatchet/clients/rest/lib/hatchet-sdk-rest/api/workflow_api.rb', line 1163

def workflow_run_get_shape_with_http_info(tenant, workflow_run, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WorkflowApi.workflow_run_get_shape ...'
  end
  # verify the required parameter 'tenant' is set
  if @api_client.config.client_side_validation && tenant.nil?
    fail ArgumentError, "Missing the required parameter 'tenant' when calling WorkflowApi.workflow_run_get_shape"
  end
  if @api_client.config.client_side_validation && tenant.to_s.length > 36
    fail ArgumentError, 'invalid value for "tenant" when calling WorkflowApi.workflow_run_get_shape, the character length must be smaller than or equal to 36.'
  end

  if @api_client.config.client_side_validation && tenant.to_s.length < 36
    fail ArgumentError, 'invalid value for "tenant" when calling WorkflowApi.workflow_run_get_shape, the character length must be greater than or equal to 36.'
  end

  # verify the required parameter 'workflow_run' is set
  if @api_client.config.client_side_validation && workflow_run.nil?
    fail ArgumentError, "Missing the required parameter 'workflow_run' when calling WorkflowApi.workflow_run_get_shape"
  end
  if @api_client.config.client_side_validation && workflow_run.to_s.length > 36
    fail ArgumentError, 'invalid value for "workflow_run" when calling WorkflowApi.workflow_run_get_shape, the character length must be smaller than or equal to 36.'
  end

  if @api_client.config.client_side_validation && workflow_run.to_s.length < 36
    fail ArgumentError, 'invalid value for "workflow_run" when calling WorkflowApi.workflow_run_get_shape, the character length must be greater than or equal to 36.'
  end

  # resource path
  local_var_path = '/api/v1/tenants/{tenant}/workflow-runs/{workflow-run}/shape'.sub('{' + 'tenant' + '}', CGI.escape(tenant.to_s)).sub('{' + 'workflow-run' + '}', CGI.escape(workflow_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']) unless header_params['Accept']

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

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

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['cookieAuth', 'bearerAuth']

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

#workflow_run_get_with_http_info(tenant, workflow_run, opts = {}) ⇒ Array<(WorkflowRun, Integer, Hash)>

Get workflow run Get a workflow run for a tenant

Parameters:

  • The tenant id

  • The workflow run id

  • (defaults to: {})

    the optional parameters

Returns:

  • WorkflowRun data, response status code and response headers



954
955
956
957
958
959
960
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
1012
1013
1014
1015
1016
1017
1018
1019
1020
 
# File 'lib/hatchet/clients/rest/lib/hatchet-sdk-rest/api/workflow_api.rb', line 954

def workflow_run_get_with_http_info(tenant, workflow_run, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WorkflowApi.workflow_run_get ...'
  end
  # verify the required parameter 'tenant' is set
  if @api_client.config.client_side_validation && tenant.nil?
    fail ArgumentError, "Missing the required parameter 'tenant' when calling WorkflowApi.workflow_run_get"
  end
  if @api_client.config.client_side_validation && tenant.to_s.length > 36
    fail ArgumentError, 'invalid value for "tenant" when calling WorkflowApi.workflow_run_get, the character length must be smaller than or equal to 36.'
  end

  if @api_client.config.client_side_validation && tenant.to_s.length < 36
    fail ArgumentError, 'invalid value for "tenant" when calling WorkflowApi.workflow_run_get, the character length must be greater than or equal to 36.'
  end

  # verify the required parameter 'workflow_run' is set
  if @api_client.config.client_side_validation && workflow_run.nil?
    fail ArgumentError, "Missing the required parameter 'workflow_run' when calling WorkflowApi.workflow_run_get"
  end
  if @api_client.config.client_side_validation && workflow_run.to_s.length > 36
    fail ArgumentError, 'invalid value for "workflow_run" when calling WorkflowApi.workflow_run_get, the character length must be smaller than or equal to 36.'
  end

  if @api_client.config.client_side_validation && workflow_run.to_s.length < 36
    fail ArgumentError, 'invalid value for "workflow_run" when calling WorkflowApi.workflow_run_get, the character length must be greater than or equal to 36.'
  end

  # resource path
  local_var_path = '/api/v1/tenants/{tenant}/workflow-runs/{workflow-run}'.sub('{' + 'tenant' + '}', CGI.escape(tenant.to_s)).sub('{' + 'workflow-run' + '}', CGI.escape(workflow_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']) unless header_params['Accept']

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

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

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['cookieAuth', 'bearerAuth']

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

#workflow_run_list(tenant, opts = {}) ⇒ WorkflowRunList

Get workflow runs Get all workflow runs for a tenant

Parameters:

  • The tenant id

  • (defaults to: {})

    the optional parameters

Options Hash (opts):

  • :offset (Integer) —

    The number to skip

  • :limit (Integer) —

    The number to limit by

  • :event_id (String) —

    The event id to get runs for.

  • :workflow_id (String) —

    The workflow id to get runs for.

  • :parent_workflow_run_id (String) —

    The parent workflow run id

  • :parent_step_run_id (String) —

    The parent step run id

  • :statuses (Array<WorkflowRunStatus>) —

    A list of workflow run statuses to filter by

  • :kinds (Array<WorkflowKind>) —

    A list of workflow kinds to filter by

  • :additional_metadata (Array<String>) —

    A list of metadata key value pairs to filter by

  • :created_after (Time) —

    The time after the workflow run was created

  • :created_before (Time) —

    The time before the workflow run was created

  • :finished_after (Time) —

    The time after the workflow run was finished

  • :finished_before (Time) —

    The time before the workflow run was finished

  • :order_by_field (WorkflowRunOrderByField) —

    The order by field

  • :order_by_direction (WorkflowRunOrderByDirection) —

    The order by direction

Returns:



1251
1252
1253
1254
 
# File 'lib/hatchet/clients/rest/lib/hatchet-sdk-rest/api/workflow_api.rb', line 1251

def workflow_run_list(tenant, opts = {})
  data, _status_code, _headers = workflow_run_list_with_http_info(tenant, opts)
  data
end

#workflow_run_list_with_http_info(tenant, opts = {}) ⇒ Array<(WorkflowRunList, Integer, Hash)>

Get workflow runs Get all workflow runs for a tenant

Parameters:

  • The tenant id

  • (defaults to: {})

    the optional parameters

Options Hash (opts):

  • :offset (Integer) —

    The number to skip

  • :limit (Integer) —

    The number to limit by

  • :event_id (String) —

    The event id to get runs for.

  • :workflow_id (String) —

    The workflow id to get runs for.

  • :parent_workflow_run_id (String) —

    The parent workflow run id

  • :parent_step_run_id (String) —

    The parent step run id

  • :statuses (Array<WorkflowRunStatus>) —

    A list of workflow run statuses to filter by

  • :kinds (Array<WorkflowKind>) —

    A list of workflow kinds to filter by

  • :additional_metadata (Array<String>) —

    A list of metadata key value pairs to filter by

  • :created_after (Time) —

    The time after the workflow run was created

  • :created_before (Time) —

    The time before the workflow run was created

  • :finished_after (Time) —

    The time after the workflow run was finished

  • :finished_before (Time) —

    The time before the workflow run was finished

  • :order_by_field (WorkflowRunOrderByField) —

    The order by field

  • :order_by_direction (WorkflowRunOrderByDirection) —

    The order by direction

Returns:

  • WorkflowRunList data, response status code and response headers



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
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
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
 
# File 'lib/hatchet/clients/rest/lib/hatchet-sdk-rest/api/workflow_api.rb', line 1276

def workflow_run_list_with_http_info(tenant, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WorkflowApi.workflow_run_list ...'
  end
  # verify the required parameter 'tenant' is set
  if @api_client.config.client_side_validation && tenant.nil?
    fail ArgumentError, "Missing the required parameter 'tenant' when calling WorkflowApi.workflow_run_list"
  end
  if @api_client.config.client_side_validation && tenant.to_s.length > 36
    fail ArgumentError, 'invalid value for "tenant" when calling WorkflowApi.workflow_run_list, the character length must be smaller than or equal to 36.'
  end

  if @api_client.config.client_side_validation && tenant.to_s.length < 36
    fail ArgumentError, 'invalid value for "tenant" when calling WorkflowApi.workflow_run_list, the character length must be greater than or equal to 36.'
  end

  if @api_client.config.client_side_validation && !opts[:'event_id'].nil? && opts[:'event_id'].to_s.length > 36
    fail ArgumentError, 'invalid value for "opts[:"event_id"]" when calling WorkflowApi.workflow_run_list, the character length must be smaller than or equal to 36.'
  end

  if @api_client.config.client_side_validation && !opts[:'event_id'].nil? && opts[:'event_id'].to_s.length < 36
    fail ArgumentError, 'invalid value for "opts[:"event_id"]" when calling WorkflowApi.workflow_run_list, the character length must be greater than or equal to 36.'
  end

  if @api_client.config.client_side_validation && !opts[:'workflow_id'].nil? && opts[:'workflow_id'].to_s.length > 36
    fail ArgumentError, 'invalid value for "opts[:"workflow_id"]" when calling WorkflowApi.workflow_run_list, the character length must be smaller than or equal to 36.'
  end

  if @api_client.config.client_side_validation && !opts[:'workflow_id'].nil? && opts[:'workflow_id'].to_s.length < 36
    fail ArgumentError, 'invalid value for "opts[:"workflow_id"]" when calling WorkflowApi.workflow_run_list, the character length must be greater than or equal to 36.'
  end

  if @api_client.config.client_side_validation && !opts[:'parent_workflow_run_id'].nil? && opts[:'parent_workflow_run_id'].to_s.length > 36
    fail ArgumentError, 'invalid value for "opts[:"parent_workflow_run_id"]" when calling WorkflowApi.workflow_run_list, the character length must be smaller than or equal to 36.'
  end

  if @api_client.config.client_side_validation && !opts[:'parent_workflow_run_id'].nil? && opts[:'parent_workflow_run_id'].to_s.length < 36
    fail ArgumentError, 'invalid value for "opts[:"parent_workflow_run_id"]" when calling WorkflowApi.workflow_run_list, the character length must be greater than or equal to 36.'
  end

  if @api_client.config.client_side_validation && !opts[:'parent_step_run_id'].nil? && opts[:'parent_step_run_id'].to_s.length > 36
    fail ArgumentError, 'invalid value for "opts[:"parent_step_run_id"]" when calling WorkflowApi.workflow_run_list, the character length must be smaller than or equal to 36.'
  end

  if @api_client.config.client_side_validation && !opts[:'parent_step_run_id'].nil? && opts[:'parent_step_run_id'].to_s.length < 36
    fail ArgumentError, 'invalid value for "opts[:"parent_step_run_id"]" when calling WorkflowApi.workflow_run_list, the character length must be greater than or equal to 36.'
  end

  # resource path
  local_var_path = '/api/v1/tenants/{tenant}/workflows/runs'.sub('{' + 'tenant' + '}', CGI.escape(tenant.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'eventId'] = opts[:'event_id'] if !opts[:'event_id'].nil?
  query_params[:'workflowId'] = opts[:'workflow_id'] if !opts[:'workflow_id'].nil?
  query_params[:'parentWorkflowRunId'] = opts[:'parent_workflow_run_id'] if !opts[:'parent_workflow_run_id'].nil?
  query_params[:'parentStepRunId'] = opts[:'parent_step_run_id'] if !opts[:'parent_step_run_id'].nil?
  query_params[:'statuses'] = @api_client.build_collection_param(opts[:'statuses'], :multi) if !opts[:'statuses'].nil?
  query_params[:'kinds'] = @api_client.build_collection_param(opts[:'kinds'], :multi) if !opts[:'kinds'].nil?
  query_params[:'additionalMetadata'] = @api_client.build_collection_param(opts[:'additional_metadata'], :multi) if !opts[:'additional_metadata'].nil?
  query_params[:'createdAfter'] = opts[:'created_after'] if !opts[:'created_after'].nil?
  query_params[:'createdBefore'] = opts[:'created_before'] if !opts[:'created_before'].nil?
  query_params[:'finishedAfter'] = opts[:'finished_after'] if !opts[:'finished_after'].nil?
  query_params[:'finishedBefore'] = opts[:'finished_before'] if !opts[:'finished_before'].nil?
  query_params[:'orderByField'] = opts[:'order_by_field'] if !opts[:'order_by_field'].nil?
  query_params[:'orderByDirection'] = opts[:'order_by_direction'] if !opts[:'order_by_direction'].nil?

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

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

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

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['cookieAuth', 'bearerAuth']

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

#workflow_scheduled_bulk_delete(tenant, scheduled_workflows_bulk_delete_request, opts = {}) ⇒ ScheduledWorkflowsBulkDeleteResponse

Bulk delete scheduled workflow runs Bulk delete scheduled workflow runs for a tenant

Parameters:

  • The tenant id

  • The input to bulk delete scheduled workflow runs

  • (defaults to: {})

    the optional parameters

Returns:



1385
1386
1387
1388
 
# File 'lib/hatchet/clients/rest/lib/hatchet-sdk-rest/api/workflow_api.rb', line 1385

def workflow_scheduled_bulk_delete(tenant, scheduled_workflows_bulk_delete_request, opts = {})
  data, _status_code, _headers = workflow_scheduled_bulk_delete_with_http_info(tenant, scheduled_workflows_bulk_delete_request, opts)
  data
end

#workflow_scheduled_bulk_delete_with_http_info(tenant, scheduled_workflows_bulk_delete_request, opts = {}) ⇒ Array<(ScheduledWorkflowsBulkDeleteResponse, Integer, Hash)>

Bulk delete scheduled workflow runs Bulk delete scheduled workflow runs for a tenant

Parameters:

  • The tenant id

  • The input to bulk delete scheduled workflow runs

  • (defaults to: {})

    the optional parameters

Returns:

  • ScheduledWorkflowsBulkDeleteResponse data, response status code and response headers



1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
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
 
# File 'lib/hatchet/clients/rest/lib/hatchet-sdk-rest/api/workflow_api.rb', line 1396

def workflow_scheduled_bulk_delete_with_http_info(tenant, scheduled_workflows_bulk_delete_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WorkflowApi.workflow_scheduled_bulk_delete ...'
  end
  # verify the required parameter 'tenant' is set
  if @api_client.config.client_side_validation && tenant.nil?
    fail ArgumentError, "Missing the required parameter 'tenant' when calling WorkflowApi.workflow_scheduled_bulk_delete"
  end
  if @api_client.config.client_side_validation && tenant.to_s.length > 36
    fail ArgumentError, 'invalid value for "tenant" when calling WorkflowApi.workflow_scheduled_bulk_delete, the character length must be smaller than or equal to 36.'
  end

  if @api_client.config.client_side_validation && tenant.to_s.length < 36
    fail ArgumentError, 'invalid value for "tenant" when calling WorkflowApi.workflow_scheduled_bulk_delete, the character length must be greater than or equal to 36.'
  end

  # verify the required parameter 'scheduled_workflows_bulk_delete_request' is set
  if @api_client.config.client_side_validation && scheduled_workflows_bulk_delete_request.nil?
    fail ArgumentError, "Missing the required parameter 'scheduled_workflows_bulk_delete_request' when calling WorkflowApi.workflow_scheduled_bulk_delete"
  end
  # resource path
  local_var_path = '/api/v1/tenants/{tenant}/workflows/scheduled/bulk-delete'.sub('{' + 'tenant' + '}', CGI.escape(tenant.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']) unless header_params['Accept']
  # 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(scheduled_workflows_bulk_delete_request)

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['cookieAuth', 'bearerAuth']

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

#workflow_scheduled_bulk_update(tenant, scheduled_workflows_bulk_update_request, opts = {}) ⇒ ScheduledWorkflowsBulkUpdateResponse

Bulk update scheduled workflow runs Bulk update (reschedule) scheduled workflow runs for a tenant

Parameters:

  • The tenant id

  • The input to bulk update scheduled workflow runs

  • (defaults to: {})

    the optional parameters

Returns:



1467
1468
1469
1470
 
# File 'lib/hatchet/clients/rest/lib/hatchet-sdk-rest/api/workflow_api.rb', line 1467

def workflow_scheduled_bulk_update(tenant, scheduled_workflows_bulk_update_request, opts = {})
  data, _status_code, _headers = workflow_scheduled_bulk_update_with_http_info(tenant, scheduled_workflows_bulk_update_request, opts)
  data
end

#workflow_scheduled_bulk_update_with_http_info(tenant, scheduled_workflows_bulk_update_request, opts = {}) ⇒ Array<(ScheduledWorkflowsBulkUpdateResponse, Integer, Hash)>

Bulk update scheduled workflow runs Bulk update (reschedule) scheduled workflow runs for a tenant

Parameters:

  • The tenant id

  • The input to bulk update scheduled workflow runs

  • (defaults to: {})

    the optional parameters

Returns:

  • ScheduledWorkflowsBulkUpdateResponse data, response status code and response headers



1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
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
 
# File 'lib/hatchet/clients/rest/lib/hatchet-sdk-rest/api/workflow_api.rb', line 1478

def workflow_scheduled_bulk_update_with_http_info(tenant, scheduled_workflows_bulk_update_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WorkflowApi.workflow_scheduled_bulk_update ...'
  end
  # verify the required parameter 'tenant' is set
  if @api_client.config.client_side_validation && tenant.nil?
    fail ArgumentError, "Missing the required parameter 'tenant' when calling WorkflowApi.workflow_scheduled_bulk_update"
  end
  if @api_client.config.client_side_validation && tenant.to_s.length > 36
    fail ArgumentError, 'invalid value for "tenant" when calling WorkflowApi.workflow_scheduled_bulk_update, the character length must be smaller than or equal to 36.'
  end

  if @api_client.config.client_side_validation && tenant.to_s.length < 36
    fail ArgumentError, 'invalid value for "tenant" when calling WorkflowApi.workflow_scheduled_bulk_update, the character length must be greater than or equal to 36.'
  end

  # verify the required parameter 'scheduled_workflows_bulk_update_request' is set
  if @api_client.config.client_side_validation && scheduled_workflows_bulk_update_request.nil?
    fail ArgumentError, "Missing the required parameter 'scheduled_workflows_bulk_update_request' when calling WorkflowApi.workflow_scheduled_bulk_update"
  end
  # resource path
  local_var_path = '/api/v1/tenants/{tenant}/workflows/scheduled/bulk-update'.sub('{' + 'tenant' + '}', CGI.escape(tenant.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']) unless header_params['Accept']
  # 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(scheduled_workflows_bulk_update_request)

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['cookieAuth', 'bearerAuth']

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

#workflow_scheduled_delete(tenant, scheduled_workflow_run, opts = {}) ⇒ nil

Delete scheduled workflow run Delete a scheduled workflow run for a tenant

Parameters:

  • The tenant id

  • The scheduled workflow id

  • (defaults to: {})

    the optional parameters

Returns:



1549
1550
1551
1552
 
# File 'lib/hatchet/clients/rest/lib/hatchet-sdk-rest/api/workflow_api.rb', line 1549

def workflow_scheduled_delete(tenant, scheduled_workflow_run, opts = {})
  workflow_scheduled_delete_with_http_info(tenant, scheduled_workflow_run, opts)
  nil
end

#workflow_scheduled_delete_with_http_info(tenant, scheduled_workflow_run, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete scheduled workflow run Delete a scheduled workflow run for a tenant

Parameters:

  • The tenant id

  • The scheduled workflow id

  • (defaults to: {})

    the optional parameters

Returns:

  • nil, response status code and response headers



1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
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
 
# File 'lib/hatchet/clients/rest/lib/hatchet-sdk-rest/api/workflow_api.rb', line 1560

def workflow_scheduled_delete_with_http_info(tenant, scheduled_workflow_run, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WorkflowApi.workflow_scheduled_delete ...'
  end
  # verify the required parameter 'tenant' is set
  if @api_client.config.client_side_validation && tenant.nil?
    fail ArgumentError, "Missing the required parameter 'tenant' when calling WorkflowApi.workflow_scheduled_delete"
  end
  if @api_client.config.client_side_validation && tenant.to_s.length > 36
    fail ArgumentError, 'invalid value for "tenant" when calling WorkflowApi.workflow_scheduled_delete, the character length must be smaller than or equal to 36.'
  end

  if @api_client.config.client_side_validation && tenant.to_s.length < 36
    fail ArgumentError, 'invalid value for "tenant" when calling WorkflowApi.workflow_scheduled_delete, the character length must be greater than or equal to 36.'
  end

  # verify the required parameter 'scheduled_workflow_run' is set
  if @api_client.config.client_side_validation && scheduled_workflow_run.nil?
    fail ArgumentError, "Missing the required parameter 'scheduled_workflow_run' when calling WorkflowApi.workflow_scheduled_delete"
  end
  if @api_client.config.client_side_validation && scheduled_workflow_run.to_s.length > 36
    fail ArgumentError, 'invalid value for "scheduled_workflow_run" when calling WorkflowApi.workflow_scheduled_delete, the character length must be smaller than or equal to 36.'
  end

  if @api_client.config.client_side_validation && scheduled_workflow_run.to_s.length < 36
    fail ArgumentError, 'invalid value for "scheduled_workflow_run" when calling WorkflowApi.workflow_scheduled_delete, the character length must be greater than or equal to 36.'
  end

  # resource path
  local_var_path = '/api/v1/tenants/{tenant}/workflows/scheduled/{scheduled-workflow-run}'.sub('{' + 'tenant' + '}', CGI.escape(tenant.to_s)).sub('{' + 'scheduled-workflow-run' + '}', CGI.escape(scheduled_workflow_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']) unless header_params['Accept']

  # 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] || ['cookieAuth', 'bearerAuth']

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

#workflow_scheduled_get(tenant, scheduled_workflow_run, opts = {}) ⇒ ScheduledWorkflows

Get scheduled workflow run Get a scheduled workflow run for a tenant

Parameters:

  • The tenant id

  • The scheduled workflow id

  • (defaults to: {})

    the optional parameters

Returns:



1634
1635
1636
1637
 
# File 'lib/hatchet/clients/rest/lib/hatchet-sdk-rest/api/workflow_api.rb', line 1634

def workflow_scheduled_get(tenant, scheduled_workflow_run, opts = {})
  data, _status_code, _headers = workflow_scheduled_get_with_http_info(tenant, scheduled_workflow_run, opts)
  data
end

#workflow_scheduled_get_with_http_info(tenant, scheduled_workflow_run, opts = {}) ⇒ Array<(ScheduledWorkflows, Integer, Hash)>

Get scheduled workflow run Get a scheduled workflow run for a tenant

Parameters:

  • The tenant id

  • The scheduled workflow id

  • (defaults to: {})

    the optional parameters

Returns:

  • ScheduledWorkflows data, response status code and response headers



1645
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
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
 
# File 'lib/hatchet/clients/rest/lib/hatchet-sdk-rest/api/workflow_api.rb', line 1645

def workflow_scheduled_get_with_http_info(tenant, scheduled_workflow_run, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WorkflowApi.workflow_scheduled_get ...'
  end
  # verify the required parameter 'tenant' is set
  if @api_client.config.client_side_validation && tenant.nil?
    fail ArgumentError, "Missing the required parameter 'tenant' when calling WorkflowApi.workflow_scheduled_get"
  end
  if @api_client.config.client_side_validation && tenant.to_s.length > 36
    fail ArgumentError, 'invalid value for "tenant" when calling WorkflowApi.workflow_scheduled_get, the character length must be smaller than or equal to 36.'
  end

  if @api_client.config.client_side_validation && tenant.to_s.length < 36
    fail ArgumentError, 'invalid value for "tenant" when calling WorkflowApi.workflow_scheduled_get, the character length must be greater than or equal to 36.'
  end

  # verify the required parameter 'scheduled_workflow_run' is set
  if @api_client.config.client_side_validation && scheduled_workflow_run.nil?
    fail ArgumentError, "Missing the required parameter 'scheduled_workflow_run' when calling WorkflowApi.workflow_scheduled_get"
  end
  if @api_client.config.client_side_validation && scheduled_workflow_run.to_s.length > 36
    fail ArgumentError, 'invalid value for "scheduled_workflow_run" when calling WorkflowApi.workflow_scheduled_get, the character length must be smaller than or equal to 36.'
  end

  if @api_client.config.client_side_validation && scheduled_workflow_run.to_s.length < 36
    fail ArgumentError, 'invalid value for "scheduled_workflow_run" when calling WorkflowApi.workflow_scheduled_get, the character length must be greater than or equal to 36.'
  end

  # resource path
  local_var_path = '/api/v1/tenants/{tenant}/workflows/scheduled/{scheduled-workflow-run}'.sub('{' + 'tenant' + '}', CGI.escape(tenant.to_s)).sub('{' + 'scheduled-workflow-run' + '}', CGI.escape(scheduled_workflow_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']) unless header_params['Accept']

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

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

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['cookieAuth', 'bearerAuth']

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

#workflow_scheduled_list(tenant, opts = {}) ⇒ ScheduledWorkflowsList

Get scheduled workflow runs Get all scheduled workflow runs for a tenant

Parameters:

  • The tenant id

  • (defaults to: {})

    the optional parameters

Options Hash (opts):

  • :offset (Integer) —

    The number to skip

  • :limit (Integer) —

    The number to limit by

  • :order_by_field (ScheduledWorkflowsOrderByField) —

    The order by field

  • :order_by_direction (WorkflowRunOrderByDirection) —

    The order by direction

  • :workflow_id (String) —

    The workflow id to get runs for.

  • :parent_workflow_run_id (String) —

    The parent workflow run id

  • :parent_step_run_id (String) —

    The parent step run id

  • :additional_metadata (Array<String>) —

    A list of metadata key value pairs to filter by

  • :statuses (Array<ScheduledRunStatus>) —

    A list of scheduled run statuses to filter by

Returns:



1727
1728
1729
1730
 
# File 'lib/hatchet/clients/rest/lib/hatchet-sdk-rest/api/workflow_api.rb', line 1727

def workflow_scheduled_list(tenant, opts = {})
  data, _status_code, _headers = workflow_scheduled_list_with_http_info(tenant, opts)
  data
end

#workflow_scheduled_list_with_http_info(tenant, opts = {}) ⇒ Array<(ScheduledWorkflowsList, Integer, Hash)>

Get scheduled workflow runs Get all scheduled workflow runs for a tenant

Parameters:

  • The tenant id

  • (defaults to: {})

    the optional parameters

Options Hash (opts):

  • :offset (Integer) —

    The number to skip

  • :limit (Integer) —

    The number to limit by

  • :order_by_field (ScheduledWorkflowsOrderByField) —

    The order by field

  • :order_by_direction (WorkflowRunOrderByDirection) —

    The order by direction

  • :workflow_id (String) —

    The workflow id to get runs for.

  • :parent_workflow_run_id (String) —

    The parent workflow run id

  • :parent_step_run_id (String) —

    The parent step run id

  • :additional_metadata (Array<String>) —

    A list of metadata key value pairs to filter by

  • :statuses (Array<ScheduledRunStatus>) —

    A list of scheduled run statuses to filter by

Returns:

  • ScheduledWorkflowsList data, response status code and response headers



1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
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
 
# File 'lib/hatchet/clients/rest/lib/hatchet-sdk-rest/api/workflow_api.rb', line 1746

def workflow_scheduled_list_with_http_info(tenant, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WorkflowApi.workflow_scheduled_list ...'
  end
  # verify the required parameter 'tenant' is set
  if @api_client.config.client_side_validation && tenant.nil?
    fail ArgumentError, "Missing the required parameter 'tenant' when calling WorkflowApi.workflow_scheduled_list"
  end
  if @api_client.config.client_side_validation && tenant.to_s.length > 36
    fail ArgumentError, 'invalid value for "tenant" when calling WorkflowApi.workflow_scheduled_list, the character length must be smaller than or equal to 36.'
  end

  if @api_client.config.client_side_validation && tenant.to_s.length < 36
    fail ArgumentError, 'invalid value for "tenant" when calling WorkflowApi.workflow_scheduled_list, the character length must be greater than or equal to 36.'
  end

  if @api_client.config.client_side_validation && !opts[:'workflow_id'].nil? && opts[:'workflow_id'].to_s.length > 36
    fail ArgumentError, 'invalid value for "opts[:"workflow_id"]" when calling WorkflowApi.workflow_scheduled_list, the character length must be smaller than or equal to 36.'
  end

  if @api_client.config.client_side_validation && !opts[:'workflow_id'].nil? && opts[:'workflow_id'].to_s.length < 36
    fail ArgumentError, 'invalid value for "opts[:"workflow_id"]" when calling WorkflowApi.workflow_scheduled_list, the character length must be greater than or equal to 36.'
  end

  if @api_client.config.client_side_validation && !opts[:'parent_workflow_run_id'].nil? && opts[:'parent_workflow_run_id'].to_s.length > 36
    fail ArgumentError, 'invalid value for "opts[:"parent_workflow_run_id"]" when calling WorkflowApi.workflow_scheduled_list, the character length must be smaller than or equal to 36.'
  end

  if @api_client.config.client_side_validation && !opts[:'parent_workflow_run_id'].nil? && opts[:'parent_workflow_run_id'].to_s.length < 36
    fail ArgumentError, 'invalid value for "opts[:"parent_workflow_run_id"]" when calling WorkflowApi.workflow_scheduled_list, the character length must be greater than or equal to 36.'
  end

  if @api_client.config.client_side_validation && !opts[:'parent_step_run_id'].nil? && opts[:'parent_step_run_id'].to_s.length > 36
    fail ArgumentError, 'invalid value for "opts[:"parent_step_run_id"]" when calling WorkflowApi.workflow_scheduled_list, the character length must be smaller than or equal to 36.'
  end

  if @api_client.config.client_side_validation && !opts[:'parent_step_run_id'].nil? && opts[:'parent_step_run_id'].to_s.length < 36
    fail ArgumentError, 'invalid value for "opts[:"parent_step_run_id"]" when calling WorkflowApi.workflow_scheduled_list, the character length must be greater than or equal to 36.'
  end

  # resource path
  local_var_path = '/api/v1/tenants/{tenant}/workflows/scheduled'.sub('{' + 'tenant' + '}', CGI.escape(tenant.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'orderByField'] = opts[:'order_by_field'] if !opts[:'order_by_field'].nil?
  query_params[:'orderByDirection'] = opts[:'order_by_direction'] if !opts[:'order_by_direction'].nil?
  query_params[:'workflowId'] = opts[:'workflow_id'] if !opts[:'workflow_id'].nil?
  query_params[:'parentWorkflowRunId'] = opts[:'parent_workflow_run_id'] if !opts[:'parent_workflow_run_id'].nil?
  query_params[:'parentStepRunId'] = opts[:'parent_step_run_id'] if !opts[:'parent_step_run_id'].nil?
  query_params[:'additionalMetadata'] = @api_client.build_collection_param(opts[:'additional_metadata'], :multi) if !opts[:'additional_metadata'].nil?
  query_params[:'statuses'] = @api_client.build_collection_param(opts[:'statuses'], :multi) if !opts[:'statuses'].nil?

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

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

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

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['cookieAuth', 'bearerAuth']

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

#workflow_scheduled_trigger(tenant, scheduled_workflow_run, opts = {}) ⇒ TriggerRunResult

Trigger scheduled workflow run Trigger a scheduled workflow run immediately for a tenant

Parameters:

  • The tenant id

  • The scheduled workflow id

  • (defaults to: {})

    the optional parameters

Returns:



1841
1842
1843
1844
 
# File 'lib/hatchet/clients/rest/lib/hatchet-sdk-rest/api/workflow_api.rb', line 1841

def workflow_scheduled_trigger(tenant, scheduled_workflow_run, opts = {})
  data, _status_code, _headers = workflow_scheduled_trigger_with_http_info(tenant, scheduled_workflow_run, opts)
  data
end

#workflow_scheduled_trigger_with_http_info(tenant, scheduled_workflow_run, opts = {}) ⇒ Array<(TriggerRunResult, Integer, Hash)>

Trigger scheduled workflow run Trigger a scheduled workflow run immediately for a tenant

Parameters:

  • The tenant id

  • The scheduled workflow id

  • (defaults to: {})

    the optional parameters

Returns:

  • TriggerRunResult data, response status code and response headers



1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
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
 
# File 'lib/hatchet/clients/rest/lib/hatchet-sdk-rest/api/workflow_api.rb', line 1852

def workflow_scheduled_trigger_with_http_info(tenant, scheduled_workflow_run, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WorkflowApi.workflow_scheduled_trigger ...'
  end
  # verify the required parameter 'tenant' is set
  if @api_client.config.client_side_validation && tenant.nil?
    fail ArgumentError, "Missing the required parameter 'tenant' when calling WorkflowApi.workflow_scheduled_trigger"
  end
  if @api_client.config.client_side_validation && tenant.to_s.length > 36
    fail ArgumentError, 'invalid value for "tenant" when calling WorkflowApi.workflow_scheduled_trigger, the character length must be smaller than or equal to 36.'
  end

  if @api_client.config.client_side_validation && tenant.to_s.length < 36
    fail ArgumentError, 'invalid value for "tenant" when calling WorkflowApi.workflow_scheduled_trigger, the character length must be greater than or equal to 36.'
  end

  # verify the required parameter 'scheduled_workflow_run' is set
  if @api_client.config.client_side_validation && scheduled_workflow_run.nil?
    fail ArgumentError, "Missing the required parameter 'scheduled_workflow_run' when calling WorkflowApi.workflow_scheduled_trigger"
  end
  if @api_client.config.client_side_validation && scheduled_workflow_run.to_s.length > 36
    fail ArgumentError, 'invalid value for "scheduled_workflow_run" when calling WorkflowApi.workflow_scheduled_trigger, the character length must be smaller than or equal to 36.'
  end

  if @api_client.config.client_side_validation && scheduled_workflow_run.to_s.length < 36
    fail ArgumentError, 'invalid value for "scheduled_workflow_run" when calling WorkflowApi.workflow_scheduled_trigger, the character length must be greater than or equal to 36.'
  end

  # resource path
  local_var_path = '/api/v1/tenants/{tenant}/workflows/scheduled/{scheduled-workflow-run}'.sub('{' + 'tenant' + '}', CGI.escape(tenant.to_s)).sub('{' + 'scheduled-workflow-run' + '}', CGI.escape(scheduled_workflow_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']) unless header_params['Accept']

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

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

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['cookieAuth', 'bearerAuth']

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

#workflow_scheduled_update(tenant, scheduled_workflow_run, update_scheduled_workflow_run_request, opts = {}) ⇒ ScheduledWorkflows

Update scheduled workflow run Update (reschedule) a scheduled workflow run for a tenant

Parameters:

  • The tenant id

  • The scheduled workflow id

  • The input to reschedule the workflow run

  • (defaults to: {})

    the optional parameters

Returns:



1927
1928
1929
1930
 
# File 'lib/hatchet/clients/rest/lib/hatchet-sdk-rest/api/workflow_api.rb', line 1927

def workflow_scheduled_update(tenant, scheduled_workflow_run, update_scheduled_workflow_run_request, opts = {})
  data, _status_code, _headers = workflow_scheduled_update_with_http_info(tenant, scheduled_workflow_run, update_scheduled_workflow_run_request, opts)
  data
end

#workflow_scheduled_update_with_http_info(tenant, scheduled_workflow_run, update_scheduled_workflow_run_request, opts = {}) ⇒ Array<(ScheduledWorkflows, Integer, Hash)>

Update scheduled workflow run Update (reschedule) a scheduled workflow run for a tenant

Parameters:

  • The tenant id

  • The scheduled workflow id

  • The input to reschedule the workflow run

  • (defaults to: {})

    the optional parameters

Returns:

  • ScheduledWorkflows data, response status code and response headers



1939
1940
1941
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
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
 
# File 'lib/hatchet/clients/rest/lib/hatchet-sdk-rest/api/workflow_api.rb', line 1939

def workflow_scheduled_update_with_http_info(tenant, scheduled_workflow_run, update_scheduled_workflow_run_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WorkflowApi.workflow_scheduled_update ...'
  end
  # verify the required parameter 'tenant' is set
  if @api_client.config.client_side_validation && tenant.nil?
    fail ArgumentError, "Missing the required parameter 'tenant' when calling WorkflowApi.workflow_scheduled_update"
  end
  if @api_client.config.client_side_validation && tenant.to_s.length > 36
    fail ArgumentError, 'invalid value for "tenant" when calling WorkflowApi.workflow_scheduled_update, the character length must be smaller than or equal to 36.'
  end

  if @api_client.config.client_side_validation && tenant.to_s.length < 36
    fail ArgumentError, 'invalid value for "tenant" when calling WorkflowApi.workflow_scheduled_update, the character length must be greater than or equal to 36.'
  end

  # verify the required parameter 'scheduled_workflow_run' is set
  if @api_client.config.client_side_validation && scheduled_workflow_run.nil?
    fail ArgumentError, "Missing the required parameter 'scheduled_workflow_run' when calling WorkflowApi.workflow_scheduled_update"
  end
  if @api_client.config.client_side_validation && scheduled_workflow_run.to_s.length > 36
    fail ArgumentError, 'invalid value for "scheduled_workflow_run" when calling WorkflowApi.workflow_scheduled_update, the character length must be smaller than or equal to 36.'
  end

  if @api_client.config.client_side_validation && scheduled_workflow_run.to_s.length < 36
    fail ArgumentError, 'invalid value for "scheduled_workflow_run" when calling WorkflowApi.workflow_scheduled_update, the character length must be greater than or equal to 36.'
  end

  # verify the required parameter 'update_scheduled_workflow_run_request' is set
  if @api_client.config.client_side_validation && update_scheduled_workflow_run_request.nil?
    fail ArgumentError, "Missing the required parameter 'update_scheduled_workflow_run_request' when calling WorkflowApi.workflow_scheduled_update"
  end
  # resource path
  local_var_path = '/api/v1/tenants/{tenant}/workflows/scheduled/{scheduled-workflow-run}'.sub('{' + 'tenant' + '}', CGI.escape(tenant.to_s)).sub('{' + 'scheduled-workflow-run' + '}', CGI.escape(scheduled_workflow_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']) unless header_params['Accept']
  # 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(update_scheduled_workflow_run_request)

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['cookieAuth', 'bearerAuth']

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

#workflow_update(workflow, workflow_update_request, opts = {}) ⇒ Workflow

Update workflow Update a workflow for a tenant

Parameters:

  • The workflow id

  • The input to update the workflow

  • (defaults to: {})

    the optional parameters

Returns:



2022
2023
2024
2025
 
# File 'lib/hatchet/clients/rest/lib/hatchet-sdk-rest/api/workflow_api.rb', line 2022

def workflow_update(workflow, workflow_update_request, opts = {})
  data, _status_code, _headers = workflow_update_with_http_info(workflow, workflow_update_request, opts)
  data
end

#workflow_update_with_http_info(workflow, workflow_update_request, opts = {}) ⇒ Array<(Workflow, Integer, Hash)>

Update workflow Update a workflow for a tenant

Parameters:

  • The workflow id

  • The input to update the workflow

  • (defaults to: {})

    the optional parameters

Returns:

  • Workflow data, response status code and response headers



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
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
 
# File 'lib/hatchet/clients/rest/lib/hatchet-sdk-rest/api/workflow_api.rb', line 2033

def workflow_update_with_http_info(workflow, workflow_update_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WorkflowApi.workflow_update ...'
  end
  # verify the required parameter 'workflow' is set
  if @api_client.config.client_side_validation && workflow.nil?
    fail ArgumentError, "Missing the required parameter 'workflow' when calling WorkflowApi.workflow_update"
  end
  if @api_client.config.client_side_validation && workflow.to_s.length > 36
    fail ArgumentError, 'invalid value for "workflow" when calling WorkflowApi.workflow_update, the character length must be smaller than or equal to 36.'
  end

  if @api_client.config.client_side_validation && workflow.to_s.length < 36
    fail ArgumentError, 'invalid value for "workflow" when calling WorkflowApi.workflow_update, the character length must be greater than or equal to 36.'
  end

  # verify the required parameter 'workflow_update_request' is set
  if @api_client.config.client_side_validation && workflow_update_request.nil?
    fail ArgumentError, "Missing the required parameter 'workflow_update_request' when calling WorkflowApi.workflow_update"
  end
  # resource path
  local_var_path = '/api/v1/workflows/{workflow}'.sub('{' + 'workflow' + '}', CGI.escape(workflow.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']) unless header_params['Accept']
  # 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(workflow_update_request)

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['cookieAuth', 'bearerAuth']

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

#workflow_version_get(workflow, opts = {}) ⇒ WorkflowVersion

Get workflow version Get a workflow version for a tenant

Parameters:

  • The workflow id

  • (defaults to: {})

    the optional parameters

Options Hash (opts):

  • :version (String) —

    The workflow version. If not supplied, the latest version is fetched.

Returns:



2104
2105
2106
2107
 
# File 'lib/hatchet/clients/rest/lib/hatchet-sdk-rest/api/workflow_api.rb', line 2104

def workflow_version_get(workflow, opts = {})
  data, _status_code, _headers = workflow_version_get_with_http_info(workflow, opts)
  data
end

#workflow_version_get_with_http_info(workflow, opts = {}) ⇒ Array<(WorkflowVersion, Integer, Hash)>

Get workflow version Get a workflow version for a tenant

Parameters:

  • The workflow id

  • (defaults to: {})

    the optional parameters

Options Hash (opts):

  • :version (String) —

    The workflow version. If not supplied, the latest version is fetched.

Returns:

  • WorkflowVersion data, response status code and response headers



2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
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
 
# File 'lib/hatchet/clients/rest/lib/hatchet-sdk-rest/api/workflow_api.rb', line 2115

def workflow_version_get_with_http_info(workflow, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WorkflowApi.workflow_version_get ...'
  end
  # verify the required parameter 'workflow' is set
  if @api_client.config.client_side_validation && workflow.nil?
    fail ArgumentError, "Missing the required parameter 'workflow' when calling WorkflowApi.workflow_version_get"
  end
  if @api_client.config.client_side_validation && workflow.to_s.length > 36
    fail ArgumentError, 'invalid value for "workflow" when calling WorkflowApi.workflow_version_get, the character length must be smaller than or equal to 36.'
  end

  if @api_client.config.client_side_validation && workflow.to_s.length < 36
    fail ArgumentError, 'invalid value for "workflow" when calling WorkflowApi.workflow_version_get, the character length must be greater than or equal to 36.'
  end

  if @api_client.config.client_side_validation && !opts[:'version'].nil? && opts[:'version'].to_s.length > 36
    fail ArgumentError, 'invalid value for "opts[:"version"]" when calling WorkflowApi.workflow_version_get, the character length must be smaller than or equal to 36.'
  end

  if @api_client.config.client_side_validation && !opts[:'version'].nil? && opts[:'version'].to_s.length < 36
    fail ArgumentError, 'invalid value for "opts[:"version"]" when calling WorkflowApi.workflow_version_get, the character length must be greater than or equal to 36.'
  end

  # resource path
  local_var_path = '/api/v1/workflows/{workflow}/versions'.sub('{' + 'workflow' + '}', CGI.escape(workflow.to_s))

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

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

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

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

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['cookieAuth', 'bearerAuth']

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