windmill-api 1.544.2

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
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
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150

# \ConcurrencyGroupsApi

All URIs are relative to */api*

Method | HTTP request | Description
------------- | ------------- | -------------
[**delete_concurrency_group**](ConcurrencyGroupsApi.md#delete_concurrency_group) | **DELETE** /concurrency_groups/prune/{concurrency_id} | Delete concurrency group
[**get_concurrency_key**](ConcurrencyGroupsApi.md#get_concurrency_key) | **GET** /concurrency_groups/{id}/key | Get the concurrency key for a job that has concurrency limits enabled
[**list_concurrency_groups**](ConcurrencyGroupsApi.md#list_concurrency_groups) | **GET** /concurrency_groups/list | List all concurrency groups
[**list_extended_jobs**](ConcurrencyGroupsApi.md#list_extended_jobs) | **GET** /w/{workspace}/concurrency_groups/list_jobs | Get intervals of job runtime concurrency



## delete_concurrency_group

> serde_json::Value delete_concurrency_group(concurrency_id)
Delete concurrency group

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**concurrency_id** | **String** |  | [required] |

### Return type

[**serde_json::Value**](serde_json::Value.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## get_concurrency_key

> String get_concurrency_key(id)
Get the concurrency key for a job that has concurrency limits enabled

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** |  | [required] |

### Return type

**String**

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## list_concurrency_groups

> Vec<models::ConcurrencyGroup> list_concurrency_groups()
List all concurrency groups

### Parameters

This endpoint does not need any parameter.

### Return type

[**Vec<models::ConcurrencyGroup>**](ConcurrencyGroup.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## list_extended_jobs

> models::ExtendedJobs list_extended_jobs(workspace, concurrency_key, row_limit, created_by, label, parent_job, script_path_exact, script_path_start, schedule_path, script_hash, started_before, started_after, created_or_started_before, running, scheduled_for_before_now, created_or_started_after, created_or_started_after_completed_jobs, job_kinds, args, tag, result, allow_wildcards, page, per_page, is_skipped, is_flow_step, has_null_parent, success, all_workspaces, is_not_schedule)
Get intervals of job runtime concurrency

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**concurrency_key** | Option<**String**> |  |  |
**row_limit** | Option<**f64**> |  |  |
**created_by** | Option<**String**> | mask to filter exact matching user creator |  |
**label** | Option<**String**> | mask to filter exact matching job's label (job labels are completed jobs with as a result an object containing a string in the array at key 'wm_labels') |  |
**parent_job** | Option<**uuid::Uuid**> | The parent job that is at the origin and responsible for the execution of this script if any |  |
**script_path_exact** | Option<**String**> | mask to filter exact matching path |  |
**script_path_start** | Option<**String**> | mask to filter matching starting path |  |
**schedule_path** | Option<**String**> | mask to filter by schedule path |  |
**script_hash** | Option<**String**> | mask to filter exact matching path |  |
**started_before** | Option<**String**> | filter on started before (inclusive) timestamp |  |
**started_after** | Option<**String**> | filter on started after (exclusive) timestamp |  |
**created_or_started_before** | Option<**String**> | filter on created_at for non non started job and started_at otherwise before (inclusive) timestamp |  |
**running** | Option<**bool**> | filter on running jobs |  |
**scheduled_for_before_now** | Option<**bool**> | filter on jobs scheduled_for before now (hence waitinf for a worker) |  |
**created_or_started_after** | Option<**String**> | filter on created_at for non non started job and started_at otherwise after (exclusive) timestamp |  |
**created_or_started_after_completed_jobs** | Option<**String**> | filter on created_at for non non started job and started_at otherwise after (exclusive) timestamp but only for the completed jobs |  |
**job_kinds** | Option<**String**> | filter on job kind (values 'preview', 'script', 'dependencies', 'flow') separated by, |  |
**args** | Option<**String**> | filter on jobs containing those args as a json subset (@> in postgres) |  |
**tag** | Option<**String**> | filter on jobs with a given tag/worker group |  |
**result** | Option<**String**> | filter on jobs containing those result as a json subset (@> in postgres) |  |
**allow_wildcards** | Option<**bool**> | allow wildcards (*) in the filter of label, tag, worker |  |
**page** | Option<**i32**> | which page to return (start at 1, default 1) |  |
**per_page** | Option<**i32**> | number of items to return for a given page (default 30, max 100) |  |
**is_skipped** | Option<**bool**> | is the job skipped |  |
**is_flow_step** | Option<**bool**> | is the job a flow step |  |
**has_null_parent** | Option<**bool**> | has null parent |  |
**success** | Option<**bool**> | filter on successful jobs |  |
**all_workspaces** | Option<**bool**> | get jobs from all workspaces (only valid if request come from the `admins` workspace) |  |
**is_not_schedule** | Option<**bool**> | is not a scheduled job |  |

### Return type

[**models::ExtendedJobs**](ExtendedJobs.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)