nomad-client 0.0.1

A Rust client for HashiCorp Nomad's API.
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
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
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
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
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314

# \ClientApi

All URIs are relative to *http://localhost:4646/v1*

Method | HTTP request | Description
------------- | ------------- | -------------
[**garbage_collect_allocation**](ClientApi.md#garbage_collect_allocation) | **get** /client/allocation/{alloc_id}/gc | forces a garbage collection of a particular, stopped allocation on a node
[**garbage_collect_allocation_0**](ClientApi.md#garbage_collect_allocation_0) | **get** /client/gc | forces a garbage collection of all stopped allocations on a node
[**get_client_allocation_stats**](ClientApi.md#get_client_allocation_stats) | **get** /client/allocation/{alloc_id}/stats | query the actual resources consumed by an allocation
[**get_client_file**](ClientApi.md#get_client_file) | **get** /client/fs/cat/{alloc_id} | reads the contents of a file in an allocation directory
[**get_client_file_at_offest**](ClientApi.md#get_client_file_at_offest) | **get** /client/fs/readat/{alloc_id} | reads the contents of a file in an allocation directory at a particular offset and limit
[**get_client_stats**](ClientApi.md#get_client_stats) | **get** /client/stats | queries the actual resources consumed on a node. The API endpoint is hosted by the Nomad client and requests have to be made to the nomad client whose resource usage metrics are of interest
[**list_client_files**](ClientApi.md#list_client_files) | **get** /client/fs/ls/{alloc_id} | lists files in an allocation directory
[**stat_client_file**](ClientApi.md#stat_client_file) | **get** /client/fs/stat/{alloc_id} | stats a file in an allocation
[**stream_client_file**](ClientApi.md#stream_client_file) | **get** /client/fs/stream/{alloc_id} | streams the contents of a file in an allocation directory
[**stream_client_logs**](ClientApi.md#stream_client_logs) | **get** /client/fs/logs/{alloc_id} | streams a task's stderr/stdout logs



## garbage_collect_allocation

> garbage_collect_allocation(alloc_id)
forces a garbage collection of a particular, stopped allocation on a node

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**alloc_id** | **String** | Specifies the UUID of the allocation. This must be the full UUID, not the short 8-character one | [required] |

### Return type

 (empty response body)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: Not defined

[[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)


## garbage_collect_allocation_0

> garbage_collect_allocation_0(node_id)
forces a garbage collection of all stopped allocations on a node

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**node_id** | Option<**String**> | node id |  |

### Return type

 (empty response body)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: Not defined

[[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_client_allocation_stats

> crate::models::AllocResourceUsage get_client_allocation_stats(alloc_id)
query the actual resources consumed by an allocation

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**alloc_id** | **String** | Specifies the UUID of the allocation. This must be the full UUID, not the short 8-character one | [required] |

### Return type

[**crate::models::AllocResourceUsage**](AllocResourceUsage.md)

### Authorization

No authorization required

### 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_client_file

> String get_client_file(alloc_id, path)
reads the contents of a file in an allocation directory

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**alloc_id** | **String** | Specifies the UUID of the allocation. This must be the full UUID, not the short 8-character one | [required] |
**path** | Option<**String**> | Specifies the path of the file to read, relative to the root of the allocation directory |  |

### Return type

**String**

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: text/plain

[[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_client_file_at_offest

> String get_client_file_at_offest(alloc_id, offset, limit, path)
reads the contents of a file in an allocation directory at a particular offset and limit

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**alloc_id** | **String** | Specifies the UUID of the allocation. This must be the full UUID, not the short 8-character one | [required] |
**offset** | **i64** | Specifies the byte offset from where content will be read | [required] |
**limit** | **i64** | Specifies the number of bytes to read from the offset | [required] |
**path** | Option<**String**> | Specifies the path of the file to read, relative to the root of the allocation directory |  |

### Return type

**String**

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: text/plain

[[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_client_stats

> Vec<crate::models::HostStats> get_client_stats(node_id)
queries the actual resources consumed on a node. The API endpoint is hosted by the Nomad client and requests have to be made to the nomad client whose resource usage metrics are of interest

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**node_id** | Option<**String**> | node id |  |

### Return type

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

### Authorization

No authorization required

### 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_client_files

> Vec<crate::models::AllocFileInfo> list_client_files(alloc_id, path)
lists files in an allocation directory

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**alloc_id** | **String** | Specifies the UUID of the allocation. This must be the full UUID, not the short 8-character one | [required] |
**path** | Option<**String**> | Specifies the path of the file to read, relative to the root of the allocation directory |  |

### Return type

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

### Authorization

No authorization required

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


## stat_client_file

> crate::models::AllocFileInfo stat_client_file(alloc_id, path)
stats a file in an allocation

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**alloc_id** | **String** | Specifies the UUID of the allocation. This must be the full UUID, not the short 8-character one | [required] |
**path** | Option<**String**> | Specifies the path of the file to read, relative to the root of the allocation directory |  |

### Return type

[**crate::models::AllocFileInfo**](AllocFileInfo.md)

### Authorization

No authorization required

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


## stream_client_file

> String stream_client_file(alloc_id, offset, path, follow, origin)
streams the contents of a file in an allocation directory

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**alloc_id** | **String** | Specifies the UUID of the allocation. This must be the full UUID, not the short 8-character one | [required] |
**offset** | **i64** | Specifies the byte offset from where content will be read | [required] |
**path** | Option<**String**> | Specifies the path of the file to read, relative to the root of the allocation directory |  |
**follow** | Option<**bool**> | Specifies whether to tail the file |  |[default to true]
**origin** | Option<**String**> | Applies the relative offset to either the start or end of the file |  |[default to start]

### Return type

**String**

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: text/plain

[[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)


## stream_client_logs

> String stream_client_logs(alloc_id, task, offset, follow, _type, origin, plain)
streams a task's stderr/stdout logs

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**alloc_id** | **String** | Specifies the UUID of the allocation. This must be the full UUID, not the short 8-character one | [required] |
**task** | **String** | Specifies the name of the task inside the allocation to stream logs from | [required] |
**offset** | **i64** | Specifies the byte offset from where content will be read | [required] |
**follow** | Option<**bool**> | Specifies whether to tail the file |  |[default to true]
**_type** | Option<**String**> | Specifies the stream to stream |  |
**origin** | Option<**String**> | Applies the relative offset to either the start or end of the file |  |[default to start]
**plain** | Option<**bool**> | is plain text format |  |

### Return type

**String**

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: text/plain

[[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)