edgegap 0.1.0

Auto-generated client library for the Edgegap API, used by the arbctl tool
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
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
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394

# \FleetsApi

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

Method | HTTP request | Description
------------- | ------------- | -------------
[**fleet_create**](FleetsApi.md#fleet_create) | **POST** /v1/fleet | Create a Fleet
[**fleet_delete**](FleetsApi.md#fleet_delete) | **DELETE** /v1/fleet/{fleet_name} | Delete a Fleet
[**fleet_get**](FleetsApi.md#fleet_get) | **GET** /v1/fleet/{fleet_name} | Get a Fleet
[**fleet_link_app_version**](FleetsApi.md#fleet_link_app_version) | **PUT** /v1/fleet/{fleet_name}/app/{app_name}/version/{version_name} | Link an Application Version to a Fleet
[**fleet_policies_create**](FleetsApi.md#fleet_policies_create) | **POST** /v1/fleet/{fleet_name}/policies | Create a Fleet Policy
[**fleet_policies_delete**](FleetsApi.md#fleet_policies_delete) | **DELETE** /v1/fleet/{fleet_name}/policies/{policy_name} | Delete a Policy
[**fleet_policies_get**](FleetsApi.md#fleet_policies_get) | **GET** /v1/fleet/{fleet_name}/policies/{policy_name} | Get a Policy
[**fleet_policies_list**](FleetsApi.md#fleet_policies_list) | **GET** /v1/fleet/{fleet_name}/policies | List All Policies of a Fleet
[**fleet_policies_update**](FleetsApi.md#fleet_policies_update) | **PATCH** /v1/fleet/{fleet_name}/policies/{policy_name} | Update a Policy
[**fleet_unlink_app_version**](FleetsApi.md#fleet_unlink_app_version) | **DELETE** /v1/fleet/{fleet_name}/app/{app_name}/version/{version_name} | Unlink an Application Version From a Fleet
[**fleet_update**](FleetsApi.md#fleet_update) | **PATCH** /v1/fleet/{fleet_name} | Update a Fleet
[**fleets**](FleetsApi.md#fleets) | **GET** /v1/fleets | List All Fleets



## fleet_create

> models::FleetPostResponse fleet_create(payload)
Create a Fleet

Create a fleet. A fleet is a top-level object; you must create child resources to work properly.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**payload** | [**FleetPostPayload**](FleetPostPayload.md) |  | [required] |

### Return type

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

### Authorization

[apiKey](../README.md#apiKey)

### HTTP request headers

- **Content-Type**: application/json
- **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)


## fleet_delete

> models::FleetDeleteResponse fleet_delete(fleet_name)
Delete a Fleet

Delete a fleet, its policies and links between the application versions.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**fleet_name** | **String** | The name of the fleet | [required] |

### Return type

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

### Authorization

[apiKey](../README.md#apiKey)

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


## fleet_get

> models::FleetGetResponse fleet_get(fleet_name)
Get a Fleet

Retrieve a fleet with its details.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**fleet_name** | **String** | The name of the fleet | [required] |

### Return type

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

### Authorization

[apiKey](../README.md#apiKey)

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


## fleet_link_app_version

> models::HorizontalScalerAppVersionLink fleet_link_app_version(fleet_name, app_name, version_name)
Link an Application Version to a Fleet

Link an application version to a fleet. By linking this version, the fleet will automatically create deployments of this version according to the fleet policies.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**fleet_name** | **String** | The name of the fleet | [required] |
**app_name** | **String** | The name of the application to link | [required] |
**version_name** | **String** | The name of the application version to link | [required] |

### Return type

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

### Authorization

[apiKey](../README.md#apiKey)

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


## fleet_policies_create

> models::FleetPoliciesPostResponse fleet_policies_create(fleet_name, payload)
Create a Fleet Policy

Create a fleet policy. Policies are conditions that the fleet must respect.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**fleet_name** | **String** | The name of the fleet | [required] |
**payload** | [**FleetPoliciesPostPayload**](FleetPoliciesPostPayload.md) |  | [required] |

### Return type

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

### Authorization

[apiKey](../README.md#apiKey)

### HTTP request headers

- **Content-Type**: application/json
- **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)


## fleet_policies_delete

> fleet_policies_delete(fleet_name, policy_name)
Delete a Policy

Delete a policy. It will not delete the fleet.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**fleet_name** | **String** | The name of the fleet | [required] |
**policy_name** | **String** | The name of the policy to delete | [required] |

### Return type

 (empty response body)

### Authorization

[apiKey](../README.md#apiKey)

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


## fleet_policies_get

> models::FleetPoliciesGetResponse fleet_policies_get(fleet_name, policy_name)
Get a Policy

Retrieve a specific policy of a fleet.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**fleet_name** | **String** | The name of the fleet | [required] |
**policy_name** | **String** | The name of the policy | [required] |

### Return type

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

### Authorization

[apiKey](../README.md#apiKey)

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


## fleet_policies_list

> models::HorizontalScalerConstraintList fleet_policies_list(fleet_name, page, limit, x_fields)
List All Policies of a Fleet

List all the policies of a fleet.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**fleet_name** | **String** | The name of the fleet | [required] |
**page** | Option<**i32**> | Page number for pagination |  |[default to 1]
**limit** | Option<**i32**> | Limit of Fleet for each page |  |[default to 10]
**x_fields** | Option<**String**> | An optional fields mask |  |

### Return type

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

### Authorization

[apiKey](../README.md#apiKey)

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


## fleet_policies_update

> models::FleetPoliciesPatchPayload fleet_policies_update(fleet_name, policy_name, payload)
Update a Policy

Update a policy with new specifications.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**fleet_name** | **String** | The name of the fleet | [required] |
**policy_name** | **String** | The name of the policy | [required] |
**payload** | [**FleetPoliciesPatchPayload**](FleetPoliciesPatchPayload.md) |  | [required] |

### Return type

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

### Authorization

[apiKey](../README.md#apiKey)

### HTTP request headers

- **Content-Type**: application/json
- **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)


## fleet_unlink_app_version

> fleet_unlink_app_version(fleet_name, app_name, version_name)
Unlink an Application Version From a Fleet

Unlink an application version from a fleet. It will not delete the application version or the fleet

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**fleet_name** | **String** | The name of the fleet | [required] |
**app_name** | **String** | The name of the application to link | [required] |
**version_name** | **String** | The name of the application version to link | [required] |

### Return type

 (empty response body)

### Authorization

[apiKey](../README.md#apiKey)

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


## fleet_update

> models::FleetPatchResponse fleet_update(fleet_name, payload)
Update a Fleet

Update a fleet with new specifications.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**fleet_name** | **String** | The name of the fleet | [required] |
**payload** | [**FleetPatchPayload**](FleetPatchPayload.md) |  | [required] |

### Return type

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

### Authorization

[apiKey](../README.md#apiKey)

### HTTP request headers

- **Content-Type**: application/json
- **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)


## fleets

> models::FleetList fleets(page, limit)
List All Fleets

List all the fleets you own.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**page** | Option<**i32**> | Page number for pagination |  |[default to 1]
**limit** | Option<**i32**> | Limit of Fleet for each page |  |[default to 10]

### Return type

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

### Authorization

[apiKey](../README.md#apiKey)

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