@scaleway/sdk 2.72.0 → 2.73.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (146) hide show
  1. package/dist/api/account/v3/api.gen.cjs +13 -32
  2. package/dist/api/account/v3/api.gen.d.ts +17 -36
  3. package/dist/api/account/v3/api.gen.js +13 -32
  4. package/dist/api/account/v3/types.gen.d.ts +187 -85
  5. package/dist/api/applesilicon/v1alpha1/api.gen.cjs +19 -46
  6. package/dist/api/applesilicon/v1alpha1/api.gen.d.ts +24 -49
  7. package/dist/api/applesilicon/v1alpha1/api.gen.js +19 -46
  8. package/dist/api/applesilicon/v1alpha1/types.gen.d.ts +310 -135
  9. package/dist/api/audit_trail/v1alpha1/api.gen.cjs +2 -5
  10. package/dist/api/audit_trail/v1alpha1/api.gen.d.ts +4 -8
  11. package/dist/api/audit_trail/v1alpha1/api.gen.js +2 -5
  12. package/dist/api/audit_trail/v1alpha1/types.gen.d.ts +110 -82
  13. package/dist/api/baremetal/v1/api.gen.cjs +28 -61
  14. package/dist/api/baremetal/v1/api.gen.d.ts +29 -60
  15. package/dist/api/baremetal/v1/api.gen.js +28 -61
  16. package/dist/api/baremetal/v1/types.gen.d.ts +802 -315
  17. package/dist/api/baremetal/v3/api.gen.cjs +7 -14
  18. package/dist/api/baremetal/v3/api.gen.d.ts +10 -15
  19. package/dist/api/baremetal/v3/api.gen.js +7 -14
  20. package/dist/api/baremetal/v3/types.gen.d.ts +82 -32
  21. package/dist/api/billing/v2beta1/api.gen.cjs +11 -20
  22. package/dist/api/billing/v2beta1/api.gen.d.ts +9 -19
  23. package/dist/api/billing/v2beta1/api.gen.js +11 -20
  24. package/dist/api/billing/v2beta1/types.gen.d.ts +231 -102
  25. package/dist/api/block/v1/api.gen.cjs +37 -55
  26. package/dist/api/block/v1/api.gen.d.ts +19 -37
  27. package/dist/api/block/v1/api.gen.js +37 -55
  28. package/dist/api/block/v1/types.gen.d.ts +306 -125
  29. package/dist/api/block/v1alpha1/api.gen.cjs +45 -64
  30. package/dist/api/block/v1alpha1/api.gen.d.ts +22 -41
  31. package/dist/api/block/v1alpha1/api.gen.js +45 -64
  32. package/dist/api/block/v1alpha1/types.gen.d.ts +327 -132
  33. package/dist/api/cockpit/v1/api.gen.cjs +100 -156
  34. package/dist/api/cockpit/v1/api.gen.d.ts +53 -112
  35. package/dist/api/cockpit/v1/api.gen.js +100 -156
  36. package/dist/api/cockpit/v1/types.gen.d.ts +567 -246
  37. package/dist/api/container/v1beta1/api.gen.cjs +7 -14
  38. package/dist/api/container/v1beta1/api.gen.d.ts +9 -16
  39. package/dist/api/container/v1beta1/api.gen.js +7 -14
  40. package/dist/api/container/v1beta1/types.gen.d.ts +648 -322
  41. package/dist/api/dedibox/v1/api.gen.cjs +45 -69
  42. package/dist/api/dedibox/v1/api.gen.d.ts +52 -62
  43. package/dist/api/dedibox/v1/api.gen.js +45 -69
  44. package/dist/api/dedibox/v1/types.gen.d.ts +1765 -645
  45. package/dist/api/domain/v2beta1/api.gen.cjs +119 -178
  46. package/dist/api/domain/v2beta1/api.gen.d.ts +71 -130
  47. package/dist/api/domain/v2beta1/api.gen.js +119 -178
  48. package/dist/api/domain/v2beta1/content.gen.d.ts +1 -4
  49. package/dist/api/domain/v2beta1/types.gen.d.ts +411 -199
  50. package/dist/api/flexibleip/v1alpha1/api.gen.cjs +10 -25
  51. package/dist/api/flexibleip/v1alpha1/api.gen.d.ts +12 -28
  52. package/dist/api/flexibleip/v1alpha1/api.gen.js +10 -25
  53. package/dist/api/flexibleip/v1alpha1/types.gen.d.ts +186 -78
  54. package/dist/api/inference/v1/api.gen.cjs +8 -11
  55. package/dist/api/inference/v1/api.gen.d.ts +6 -9
  56. package/dist/api/inference/v1/api.gen.js +8 -11
  57. package/dist/api/inference/v1/types.gen.d.ts +330 -150
  58. package/dist/api/inference/v1beta1/api.gen.cjs +8 -11
  59. package/dist/api/inference/v1beta1/api.gen.d.ts +6 -9
  60. package/dist/api/inference/v1beta1/api.gen.js +8 -11
  61. package/dist/api/inference/v1beta1/types.gen.d.ts +341 -154
  62. package/dist/api/instance/v1/api.gen.cjs +64 -113
  63. package/dist/api/instance/v1/api.gen.d.ts +54 -103
  64. package/dist/api/instance/v1/api.gen.js +64 -113
  65. package/dist/api/instance/v1/types.gen.d.ts +1351 -598
  66. package/dist/api/instance/v1/types.private.gen.d.ts +131 -59
  67. package/dist/api/interlink/v1beta1/api.gen.cjs +21 -67
  68. package/dist/api/interlink/v1beta1/api.gen.d.ts +23 -70
  69. package/dist/api/interlink/v1beta1/api.gen.js +21 -67
  70. package/dist/api/interlink/v1beta1/marshalling.gen.cjs +2 -0
  71. package/dist/api/interlink/v1beta1/marshalling.gen.js +2 -0
  72. package/dist/api/interlink/v1beta1/types.gen.d.ts +464 -216
  73. package/dist/api/interlink/v1beta1/validation-rules.gen.cjs +8 -0
  74. package/dist/api/interlink/v1beta1/validation-rules.gen.d.ts +8 -0
  75. package/dist/api/interlink/v1beta1/validation-rules.gen.js +8 -0
  76. package/dist/api/iot/v1/api.gen.cjs +37 -70
  77. package/dist/api/iot/v1/api.gen.d.ts +34 -67
  78. package/dist/api/iot/v1/api.gen.js +37 -70
  79. package/dist/api/iot/v1/types.gen.d.ts +566 -321
  80. package/dist/api/ipam/v1/api.gen.cjs +6 -26
  81. package/dist/api/ipam/v1/api.gen.d.ts +8 -29
  82. package/dist/api/ipam/v1/api.gen.js +6 -26
  83. package/dist/api/ipam/v1/types.gen.d.ts +146 -105
  84. package/dist/api/jobs/v1alpha1/api.gen.cjs +2 -4
  85. package/dist/api/jobs/v1alpha1/api.gen.d.ts +4 -6
  86. package/dist/api/jobs/v1alpha1/api.gen.js +2 -4
  87. package/dist/api/jobs/v1alpha1/types.gen.d.ts +165 -91
  88. package/dist/api/k8s/v1/api.gen.cjs +33 -78
  89. package/dist/api/k8s/v1/api.gen.d.ts +27 -72
  90. package/dist/api/k8s/v1/api.gen.js +33 -78
  91. package/dist/api/k8s/v1/types.gen.d.ts +743 -506
  92. package/dist/api/key_manager/v1alpha1/api.gen.cjs +21 -57
  93. package/dist/api/key_manager/v1alpha1/api.gen.d.ts +19 -56
  94. package/dist/api/key_manager/v1alpha1/api.gen.js +21 -57
  95. package/dist/api/key_manager/v1alpha1/types.gen.d.ts +196 -114
  96. package/dist/api/marketplace/v2/api.gen.cjs +8 -21
  97. package/dist/api/marketplace/v2/api.gen.d.ts +10 -24
  98. package/dist/api/marketplace/v2/api.gen.js +8 -21
  99. package/dist/api/marketplace/v2/types.gen.d.ts +94 -41
  100. package/dist/api/mnq/v1beta1/api.gen.cjs +24 -76
  101. package/dist/api/mnq/v1beta1/api.gen.d.ts +30 -82
  102. package/dist/api/mnq/v1beta1/api.gen.js +24 -76
  103. package/dist/api/mnq/v1beta1/types.gen.d.ts +342 -169
  104. package/dist/api/mongodb/v1alpha1/api.gen.cjs +19 -62
  105. package/dist/api/mongodb/v1alpha1/api.gen.d.ts +21 -64
  106. package/dist/api/mongodb/v1alpha1/api.gen.js +19 -62
  107. package/dist/api/mongodb/v1alpha1/types.gen.d.ts +443 -189
  108. package/dist/api/qaas/v1alpha1/api.gen.cjs +17 -34
  109. package/dist/api/qaas/v1alpha1/api.gen.d.ts +19 -36
  110. package/dist/api/qaas/v1alpha1/api.gen.js +17 -34
  111. package/dist/api/qaas/v1alpha1/types.gen.d.ts +502 -174
  112. package/dist/api/rdb/v1/api.gen.cjs +62 -202
  113. package/dist/api/rdb/v1/api.gen.d.ts +60 -201
  114. package/dist/api/rdb/v1/api.gen.js +62 -202
  115. package/dist/api/rdb/v1/types.gen.d.ts +1005 -524
  116. package/dist/api/redis/v1/api.gen.cjs +23 -83
  117. package/dist/api/redis/v1/api.gen.d.ts +25 -85
  118. package/dist/api/redis/v1/api.gen.js +23 -83
  119. package/dist/api/redis/v1/types.gen.d.ts +447 -170
  120. package/dist/api/registry/v1/api.gen.cjs +12 -40
  121. package/dist/api/registry/v1/api.gen.d.ts +14 -42
  122. package/dist/api/registry/v1/api.gen.js +12 -40
  123. package/dist/api/registry/v1/types.gen.d.ts +200 -116
  124. package/dist/api/secret/v1beta1/api.gen.cjs +19 -47
  125. package/dist/api/secret/v1beta1/api.gen.d.ts +21 -51
  126. package/dist/api/secret/v1beta1/api.gen.js +19 -47
  127. package/dist/api/secret/v1beta1/types.gen.d.ts +359 -224
  128. package/dist/api/serverless_sqldb/v1alpha1/api.gen.cjs +9 -27
  129. package/dist/api/serverless_sqldb/v1alpha1/api.gen.d.ts +11 -29
  130. package/dist/api/serverless_sqldb/v1alpha1/api.gen.js +9 -27
  131. package/dist/api/serverless_sqldb/v1alpha1/types.gen.d.ts +168 -76
  132. package/dist/api/tem/v1alpha1/api.gen.cjs +22 -58
  133. package/dist/api/tem/v1alpha1/api.gen.d.ts +24 -60
  134. package/dist/api/tem/v1alpha1/api.gen.js +22 -58
  135. package/dist/api/tem/v1alpha1/types.gen.d.ts +761 -338
  136. package/dist/api/test/v1/api.gen.cjs +8 -11
  137. package/dist/api/test/v1/api.gen.d.ts +6 -9
  138. package/dist/api/test/v1/api.gen.js +8 -11
  139. package/dist/api/test/v1/types.gen.d.ts +21 -10
  140. package/dist/client/dist/package.json.cjs +1 -1
  141. package/dist/client/dist/package.json.js +1 -1
  142. package/node_modules/@scaleway/sdk-client/dist/package.json.cjs +1 -1
  143. package/node_modules/@scaleway/sdk-client/dist/package.json.js +1 -1
  144. package/node_modules/@scaleway/sdk-client/package.json +1 -2
  145. package/package.json +2 -2
  146. package/node_modules/@scaleway/sdk-client/LICENSE +0 -191
@@ -92,9 +92,7 @@ class API extends api.API {
92
92
  options
93
93
  );
94
94
  /**
95
- * Update a Cluster. Update information on a specific Kubernetes cluster. You
96
- * can update details such as its name, description, tags and configuration.
97
- * To upgrade a cluster, you will need to use the dedicated endpoint.
95
+ * Update a Cluster. Update information on a specific Kubernetes cluster. You can update details such as its name, description, tags and configuration. To upgrade a cluster, you will need to use the dedicated endpoint.
98
96
  *
99
97
  * @param request - The request {@link UpdateClusterRequest}
100
98
  * @returns A Promise of Cluster
@@ -111,9 +109,7 @@ class API extends api.API {
111
109
  marshalling_gen.unmarshalCluster
112
110
  );
113
111
  /**
114
- * Delete a Cluster. Delete a specific Kubernetes cluster and all its
115
- * associated pools and nodes, and possibly its associated Load Balancers or
116
- * Block Volumes.
112
+ * Delete a Cluster. Delete a specific Kubernetes cluster and all its associated pools and nodes, and possibly its associated Load Balancers or Block Volumes.
117
113
  *
118
114
  * @param request - The request {@link DeleteClusterRequest}
119
115
  * @returns A Promise of Cluster
@@ -130,8 +126,7 @@ class API extends api.API {
130
126
  marshalling_gen.unmarshalCluster
131
127
  );
132
128
  /**
133
- * Upgrade a Cluster. Upgrade a specific Kubernetes cluster and possibly its
134
- * associated pools to a specific and supported Kubernetes version.
129
+ * Upgrade a Cluster. Upgrade a specific Kubernetes cluster and possibly its associated pools to a specific and supported Kubernetes version.
135
130
  *
136
131
  * @param request - The request {@link UpgradeClusterRequest}
137
132
  * @returns A Promise of Cluster
@@ -148,9 +143,7 @@ class API extends api.API {
148
143
  marshalling_gen.unmarshalCluster
149
144
  );
150
145
  /**
151
- * Change the Cluster type. Change the type of a specific Kubernetes cluster.
152
- * To see the possible values you can enter for the `type` field, [list
153
- * available cluster types](#list-available-cluster-types-for-a-cluster).
146
+ * Change the Cluster type. Change the type of a specific Kubernetes cluster. To see the possible values you can enter for the `type` field, [list available cluster types](#list-available-cluster-types-for-a-cluster).
154
147
  *
155
148
  * @param request - The request {@link SetClusterTypeRequest}
156
149
  * @returns A Promise of Cluster
@@ -167,11 +160,7 @@ class API extends api.API {
167
160
  marshalling_gen.unmarshalCluster
168
161
  );
169
162
  /**
170
- * List available versions for a Cluster. List the versions that a specific
171
- * Kubernetes cluster is allowed to upgrade to. Results will include every
172
- * patch version greater than the current patch, as well as one minor version
173
- * ahead of the current version. Any upgrade skipping a minor version will not
174
- * work.
163
+ * List available versions for a Cluster. List the versions that a specific Kubernetes cluster is allowed to upgrade to. Results will include every patch version greater than the current patch, as well as one minor version ahead of the current version. Any upgrade skipping a minor version will not work.
175
164
  *
176
165
  * @param request - The request {@link ListClusterAvailableVersionsRequest}
177
166
  * @returns A Promise of ListClusterAvailableVersionsResponse
@@ -184,8 +173,7 @@ class API extends api.API {
184
173
  marshalling_gen.unmarshalListClusterAvailableVersionsResponse
185
174
  );
186
175
  /**
187
- * List available cluster types for a cluster. List the cluster types that a
188
- * specific Kubernetes cluster is allowed to switch to.
176
+ * List available cluster types for a cluster. List the cluster types that a specific Kubernetes cluster is allowed to switch to.
189
177
  *
190
178
  * @param request - The request {@link ListClusterAvailableTypesRequest}
191
179
  * @returns A Promise of ListClusterAvailableTypesResponse
@@ -204,10 +192,7 @@ class API extends api.API {
204
192
  responseType: "blob"
205
193
  });
206
194
  /**
207
- * Reset the admin token of a Cluster. Reset the admin token for a specific
208
- * Kubernetes cluster. This will revoke the old admin token (which will not be
209
- * usable afterwards) and create a new one. Note that you will need to
210
- * download the kubeconfig again to keep interacting with the cluster.
195
+ * Reset the admin token of a Cluster. Reset the admin token for a specific Kubernetes cluster. This will revoke the old admin token (which will not be usable afterwards) and create a new one. Note that you will need to download the kubeconfig again to keep interacting with the cluster.
211
196
  *
212
197
  * @param request - The request {@link ResetClusterAdminTokenRequest}
213
198
  */
@@ -218,14 +203,12 @@ class API extends api.API {
218
203
  path: `/k8s/v1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/clusters/${marshalling.validatePathParam("clusterId", request.clusterId)}/reset-admin-token`
219
204
  });
220
205
  /**
221
- * Migrate a cluster to SBS CSI. Enable the latest CSI compatible with
222
- * Scaleway Block Storage (SBS) and migrate all existing
223
- * PersistentVolumes/VolumeSnapshotContents to SBS. Make sure to have the
224
- * necessary Quota before running this command.
225
- *
226
- * @param request - The request {@link MigrateClusterToSBSCSIRequest}
227
- * @returns A Promise of Cluster
228
- */
206
+ * Migrate a cluster to SBS CSI. Enable the latest CSI compatible with Scaleway Block Storage (SBS) and migrate all existing PersistentVolumes/VolumeSnapshotContents to SBS.
207
+ Make sure to have the necessary Quota before running this command.
208
+ *
209
+ * @param request - The request {@link MigrateClusterToSBSCSIRequest}
210
+ * @returns A Promise of Cluster
211
+ */
229
212
  migrateClusterToSBSCSI = (request) => this.client.fetch(
230
213
  {
231
214
  body: "{}",
@@ -317,16 +300,14 @@ class API extends api.API {
317
300
  marshalling_gen.unmarshalListPoolsResponse
318
301
  );
319
302
  /**
320
- * List Pools in a Cluster. List all the existing pools for a specific
321
- * Kubernetes cluster.
303
+ * List Pools in a Cluster. List all the existing pools for a specific Kubernetes cluster.
322
304
  *
323
305
  * @param request - The request {@link ListPoolsRequest}
324
306
  * @returns A Promise of ListPoolsResponse
325
307
  */
326
308
  listPools = (request) => resourcePaginator.enrichForPagination("pools", this.pageOfListPools, request);
327
309
  /**
328
- * Create a new Pool in a Cluster. Create a new pool in a specific Kubernetes
329
- * cluster.
310
+ * Create a new Pool in a Cluster. Create a new pool in a specific Kubernetes cluster.
330
311
  *
331
312
  * @param request - The request {@link CreatePoolRequest}
332
313
  * @returns A Promise of Pool
@@ -343,8 +324,7 @@ class API extends api.API {
343
324
  marshalling_gen.unmarshalPool
344
325
  );
345
326
  /**
346
- * Get a Pool in a Cluster. Retrieve details about a specific pool in a
347
- * Kubernetes cluster.
327
+ * Get a Pool in a Cluster. Retrieve details about a specific pool in a Kubernetes cluster.
348
328
  *
349
329
  * @param request - The request {@link GetPoolRequest}
350
330
  * @returns A Promise of Pool
@@ -370,13 +350,12 @@ class API extends api.API {
370
350
  options
371
351
  );
372
352
  /**
373
- * Upgrade a Pool in a Cluster. Upgrade the Kubernetes version of a specific
374
- * pool. Note that it only works if the targeted version matches the cluster's
375
- * version. This will drain and replace the nodes in that pool.
376
- *
377
- * @param request - The request {@link UpgradePoolRequest}
378
- * @returns A Promise of Pool
379
- */
353
+ * Upgrade a Pool in a Cluster. Upgrade the Kubernetes version of a specific pool. Note that it only works if the targeted version matches the cluster's version.
354
+ This will drain and replace the nodes in that pool.
355
+ *
356
+ * @param request - The request {@link UpgradePoolRequest}
357
+ * @returns A Promise of Pool
358
+ */
380
359
  upgradePool = (request) => this.client.fetch(
381
360
  {
382
361
  body: JSON.stringify(
@@ -389,9 +368,7 @@ class API extends api.API {
389
368
  marshalling_gen.unmarshalPool
390
369
  );
391
370
  /**
392
- * Update a Pool in a Cluster. Update the attributes of a specific pool, such
393
- * as its desired size, autoscaling settings, and tags. To upgrade a pool, you
394
- * will need to use the dedicated endpoint.
371
+ * Update a Pool in a Cluster. Update the attributes of a specific pool, such as its desired size, autoscaling settings, and tags. To upgrade a pool, you will need to use the dedicated endpoint.
395
372
  *
396
373
  * @param request - The request {@link UpdatePoolRequest}
397
374
  * @returns A Promise of Pool
@@ -408,8 +385,7 @@ class API extends api.API {
408
385
  marshalling_gen.unmarshalPool
409
386
  );
410
387
  /**
411
- * Delete a Pool in a Cluster. Delete a specific pool from a cluster. Note
412
- * that all the pool's nodes will also be deleted.
388
+ * Delete a Pool in a Cluster. Delete a specific pool from a cluster. Note that all the pool's nodes will also be deleted.
413
389
  *
414
390
  * @param request - The request {@link DeletePoolRequest}
415
391
  * @returns A Promise of Pool
@@ -422,9 +398,7 @@ class API extends api.API {
422
398
  marshalling_gen.unmarshalPool
423
399
  );
424
400
  /**
425
- * Fetch node metadata. Rerieve metadata to instantiate a Kapsule/Kosmos node.
426
- * This method is not intended to be called by end users but rather
427
- * programmatically by the node-installer.
401
+ * Fetch node metadata. Rerieve metadata to instantiate a Kapsule/Kosmos node. This method is not intended to be called by end users but rather programmatically by the node-installer.
428
402
  *
429
403
  * @param request - The request {@link GetNodeMetadataRequest}
430
404
  * @returns A Promise of NodeMetadata
@@ -437,9 +411,7 @@ class API extends api.API {
437
411
  marshalling_gen.unmarshalNodeMetadata
438
412
  );
439
413
  /**
440
- * Authenticate Kosmos external node. Creates a newer Kosmos node and returns
441
- * its token. This method is not intended to be called by end users but rather
442
- * programmatically by the node-installer.
414
+ * Authenticate Kosmos external node. Creates a newer Kosmos node and returns its token. This method is not intended to be called by end users but rather programmatically by the node-installer.
443
415
  *
444
416
  * @param request - The request {@link AuthExternalNodeRequest}
445
417
  * @returns A Promise of ExternalNodeAuth
@@ -454,9 +426,7 @@ class API extends api.API {
454
426
  marshalling_gen.unmarshalExternalNodeAuth
455
427
  );
456
428
  /**
457
- * Create a Kosmos node. Retrieve metadata for a Kosmos node. This method is
458
- * not intended to be called by end users but rather programmatically by the
459
- * kapsule-node-agent.
429
+ * Create a Kosmos node. Retrieve metadata for a Kosmos node. This method is not intended to be called by end users but rather programmatically by the kapsule-node-agent.
460
430
  *
461
431
  * @param request - The request {@link CreateExternalNodeRequest}
462
432
  * @returns A Promise of ExternalNode
@@ -489,8 +459,7 @@ class API extends api.API {
489
459
  marshalling_gen.unmarshalListNodesResponse
490
460
  );
491
461
  /**
492
- * List Nodes in a Cluster. List all the existing nodes for a specific
493
- * Kubernetes cluster.
462
+ * List Nodes in a Cluster. List all the existing nodes for a specific Kubernetes cluster.
494
463
  *
495
464
  * @param request - The request {@link ListNodesRequest}
496
465
  * @returns A Promise of ListNodesResponse
@@ -523,11 +492,7 @@ class API extends api.API {
523
492
  options
524
493
  );
525
494
  /**
526
- * Replace a Node in a Cluster. Replace a specific Node. The node will first
527
- * be drained and pods will be rescheduled onto another node. Note that when
528
- * there is not enough space to reschedule all the pods (such as in a one-node
529
- * cluster, or with specific constraints), disruption of your applications may
530
- * occur.
495
+ * Replace a Node in a Cluster. Replace a specific Node. The node will first be drained and pods will be rescheduled onto another node. Note that when there is not enough space to reschedule all the pods (such as in a one-node cluster, or with specific constraints), disruption of your applications may occur.
531
496
  *
532
497
  * @deprecated
533
498
  * @param request - The request {@link ReplaceNodeRequest}
@@ -543,11 +508,7 @@ class API extends api.API {
543
508
  marshalling_gen.unmarshalNode
544
509
  );
545
510
  /**
546
- * Reboot a Node in a Cluster. Reboot a specific Node. The node will first be
547
- * drained and pods will be rescheduled onto another node. Note that when
548
- * there is not enough space to reschedule all the pods (such as in a one-node
549
- * cluster, or with specific constraints), disruption of your applications may
550
- * occur.
511
+ * Reboot a Node in a Cluster. Reboot a specific Node. The node will first be drained and pods will be rescheduled onto another node. Note that when there is not enough space to reschedule all the pods (such as in a one-node cluster, or with specific constraints), disruption of your applications may occur.
551
512
  *
552
513
  * @param request - The request {@link RebootNodeRequest}
553
514
  * @returns A Promise of Node
@@ -562,11 +523,7 @@ class API extends api.API {
562
523
  marshalling_gen.unmarshalNode
563
524
  );
564
525
  /**
565
- * Delete a Node in a Cluster. Delete a specific Node. The node will first be
566
- * drained and pods will be rescheduled onto another node. Note that when
567
- * there is not enough space to reschedule all the pods (such as in a one-node
568
- * cluster, or with specific constraints), disruption of your applications may
569
- * occur.
526
+ * Delete a Node in a Cluster. Delete a specific Node. The node will first be drained and pods will be rescheduled onto another node. Note that when there is not enough space to reschedule all the pods (such as in a one-node cluster, or with specific constraints), disruption of your applications may occur.
570
527
  *
571
528
  * @param request - The request {@link DeleteNodeRequest}
572
529
  * @returns A Promise of Node
@@ -583,8 +540,7 @@ class API extends api.API {
583
540
  marshalling_gen.unmarshalNode
584
541
  );
585
542
  /**
586
- * List all available Versions. List all available versions for the creation
587
- * of a new Kubernetes cluster.
543
+ * List all available Versions. List all available versions for the creation of a new Kubernetes cluster.
588
544
  *
589
545
  * @param request - The request {@link ListVersionsRequest}
590
546
  * @returns A Promise of ListVersionsResponse
@@ -624,8 +580,7 @@ class API extends api.API {
624
580
  marshalling_gen.unmarshalListClusterTypesResponse
625
581
  );
626
582
  /**
627
- * List cluster types. List available cluster types and their technical
628
- * details.
583
+ * List cluster types. List available cluster types and their technical details.
629
584
  *
630
585
  * @param request - The request {@link ListClusterTypesRequest}
631
586
  * @returns A Promise of ListClusterTypesResponse
@@ -3,8 +3,8 @@ import type { Region as ScwRegion, WaitForOptions } from '@scaleway/sdk-client';
3
3
  import type { AddClusterACLRulesRequest, AddClusterACLRulesResponse, AuthExternalNodeRequest, Cluster, CreateClusterRequest, CreateExternalNodeRequest, CreatePoolRequest, DeleteACLRuleRequest, DeleteClusterRequest, DeleteNodeRequest, DeletePoolRequest, ExternalNode, ExternalNodeAuth, GetClusterKubeConfigRequest, GetClusterRequest, GetNodeMetadataRequest, GetNodeRequest, GetPoolRequest, GetVersionRequest, ListClusterACLRulesRequest, ListClusterACLRulesResponse, ListClusterAvailableTypesRequest, ListClusterAvailableTypesResponse, ListClusterAvailableVersionsRequest, ListClusterAvailableVersionsResponse, ListClusterTypesRequest, ListClusterTypesResponse, ListClustersRequest, ListClustersResponse, ListNodesRequest, ListNodesResponse, ListPoolsRequest, ListPoolsResponse, ListVersionsRequest, ListVersionsResponse, MigrateClusterToSBSCSIRequest, Node, NodeMetadata, Pool, RebootNodeRequest, ReplaceNodeRequest, ResetClusterAdminTokenRequest, SetClusterACLRulesRequest, SetClusterACLRulesResponse, SetClusterTypeRequest, UpdateClusterRequest, UpdatePoolRequest, UpgradeClusterRequest, UpgradePoolRequest, Version } from './types.gen';
4
4
  /**
5
5
  * Kubernetes API.
6
- *
7
- * This API allows you to manage Kubernetes Kapsule and Kosmos clusters.
6
+
7
+ This API allows you to manage Kubernetes Kapsule and Kosmos clusters.
8
8
  */
9
9
  export declare class API extends ParentAPI {
10
10
  /** Lists the available regions of the API. */
@@ -43,54 +43,42 @@ export declare class API extends ParentAPI {
43
43
  */
44
44
  waitForCluster: (request: Readonly<GetClusterRequest>, options?: Readonly<WaitForOptions<Cluster>>) => Promise<Cluster>;
45
45
  /**
46
- * Update a Cluster. Update information on a specific Kubernetes cluster. You
47
- * can update details such as its name, description, tags and configuration.
48
- * To upgrade a cluster, you will need to use the dedicated endpoint.
46
+ * Update a Cluster. Update information on a specific Kubernetes cluster. You can update details such as its name, description, tags and configuration. To upgrade a cluster, you will need to use the dedicated endpoint.
49
47
  *
50
48
  * @param request - The request {@link UpdateClusterRequest}
51
49
  * @returns A Promise of Cluster
52
50
  */
53
51
  updateCluster: (request: Readonly<UpdateClusterRequest>) => Promise<Cluster>;
54
52
  /**
55
- * Delete a Cluster. Delete a specific Kubernetes cluster and all its
56
- * associated pools and nodes, and possibly its associated Load Balancers or
57
- * Block Volumes.
53
+ * Delete a Cluster. Delete a specific Kubernetes cluster and all its associated pools and nodes, and possibly its associated Load Balancers or Block Volumes.
58
54
  *
59
55
  * @param request - The request {@link DeleteClusterRequest}
60
56
  * @returns A Promise of Cluster
61
57
  */
62
58
  deleteCluster: (request: Readonly<DeleteClusterRequest>) => Promise<Cluster>;
63
59
  /**
64
- * Upgrade a Cluster. Upgrade a specific Kubernetes cluster and possibly its
65
- * associated pools to a specific and supported Kubernetes version.
60
+ * Upgrade a Cluster. Upgrade a specific Kubernetes cluster and possibly its associated pools to a specific and supported Kubernetes version.
66
61
  *
67
62
  * @param request - The request {@link UpgradeClusterRequest}
68
63
  * @returns A Promise of Cluster
69
64
  */
70
65
  upgradeCluster: (request: Readonly<UpgradeClusterRequest>) => Promise<Cluster>;
71
66
  /**
72
- * Change the Cluster type. Change the type of a specific Kubernetes cluster.
73
- * To see the possible values you can enter for the `type` field, [list
74
- * available cluster types](#list-available-cluster-types-for-a-cluster).
67
+ * Change the Cluster type. Change the type of a specific Kubernetes cluster. To see the possible values you can enter for the `type` field, [list available cluster types](#list-available-cluster-types-for-a-cluster).
75
68
  *
76
69
  * @param request - The request {@link SetClusterTypeRequest}
77
70
  * @returns A Promise of Cluster
78
71
  */
79
72
  setClusterType: (request: Readonly<SetClusterTypeRequest>) => Promise<Cluster>;
80
73
  /**
81
- * List available versions for a Cluster. List the versions that a specific
82
- * Kubernetes cluster is allowed to upgrade to. Results will include every
83
- * patch version greater than the current patch, as well as one minor version
84
- * ahead of the current version. Any upgrade skipping a minor version will not
85
- * work.
74
+ * List available versions for a Cluster. List the versions that a specific Kubernetes cluster is allowed to upgrade to. Results will include every patch version greater than the current patch, as well as one minor version ahead of the current version. Any upgrade skipping a minor version will not work.
86
75
  *
87
76
  * @param request - The request {@link ListClusterAvailableVersionsRequest}
88
77
  * @returns A Promise of ListClusterAvailableVersionsResponse
89
78
  */
90
79
  listClusterAvailableVersions: (request: Readonly<ListClusterAvailableVersionsRequest>) => Promise<ListClusterAvailableVersionsResponse>;
91
80
  /**
92
- * List available cluster types for a cluster. List the cluster types that a
93
- * specific Kubernetes cluster is allowed to switch to.
81
+ * List available cluster types for a cluster. List the cluster types that a specific Kubernetes cluster is allowed to switch to.
94
82
  *
95
83
  * @param request - The request {@link ListClusterAvailableTypesRequest}
96
84
  * @returns A Promise of ListClusterAvailableTypesResponse
@@ -98,19 +86,14 @@ export declare class API extends ParentAPI {
98
86
  listClusterAvailableTypes: (request: Readonly<ListClusterAvailableTypesRequest>) => Promise<ListClusterAvailableTypesResponse>;
99
87
  protected _getClusterKubeConfig: (request: Readonly<GetClusterKubeConfigRequest>) => Promise<Blob>;
100
88
  /**
101
- * Reset the admin token of a Cluster. Reset the admin token for a specific
102
- * Kubernetes cluster. This will revoke the old admin token (which will not be
103
- * usable afterwards) and create a new one. Note that you will need to
104
- * download the kubeconfig again to keep interacting with the cluster.
89
+ * Reset the admin token of a Cluster. Reset the admin token for a specific Kubernetes cluster. This will revoke the old admin token (which will not be usable afterwards) and create a new one. Note that you will need to download the kubeconfig again to keep interacting with the cluster.
105
90
  *
106
91
  * @param request - The request {@link ResetClusterAdminTokenRequest}
107
92
  */
108
93
  resetClusterAdminToken: (request: Readonly<ResetClusterAdminTokenRequest>) => Promise<void>;
109
94
  /**
110
- * Migrate a cluster to SBS CSI. Enable the latest CSI compatible with
111
- * Scaleway Block Storage (SBS) and migrate all existing
112
- * PersistentVolumes/VolumeSnapshotContents to SBS. Make sure to have the
113
- * necessary Quota before running this command.
95
+ * Migrate a cluster to SBS CSI. Enable the latest CSI compatible with Scaleway Block Storage (SBS) and migrate all existing PersistentVolumes/VolumeSnapshotContents to SBS.
96
+ Make sure to have the necessary Quota before running this command.
114
97
  *
115
98
  * @param request - The request {@link MigrateClusterToSBSCSIRequest}
116
99
  * @returns A Promise of Cluster
@@ -149,8 +132,7 @@ export declare class API extends ParentAPI {
149
132
  deleteACLRule: (request: Readonly<DeleteACLRuleRequest>) => Promise<void>;
150
133
  protected pageOfListPools: (request: Readonly<ListPoolsRequest>) => Promise<ListPoolsResponse>;
151
134
  /**
152
- * List Pools in a Cluster. List all the existing pools for a specific
153
- * Kubernetes cluster.
135
+ * List Pools in a Cluster. List all the existing pools for a specific Kubernetes cluster.
154
136
  *
155
137
  * @param request - The request {@link ListPoolsRequest}
156
138
  * @returns A Promise of ListPoolsResponse
@@ -160,16 +142,14 @@ export declare class API extends ParentAPI {
160
142
  [Symbol.asyncIterator]: () => AsyncGenerator<Pool[], void, void>;
161
143
  };
162
144
  /**
163
- * Create a new Pool in a Cluster. Create a new pool in a specific Kubernetes
164
- * cluster.
145
+ * Create a new Pool in a Cluster. Create a new pool in a specific Kubernetes cluster.
165
146
  *
166
147
  * @param request - The request {@link CreatePoolRequest}
167
148
  * @returns A Promise of Pool
168
149
  */
169
150
  createPool: (request: Readonly<CreatePoolRequest>) => Promise<Pool>;
170
151
  /**
171
- * Get a Pool in a Cluster. Retrieve details about a specific pool in a
172
- * Kubernetes cluster.
152
+ * Get a Pool in a Cluster. Retrieve details about a specific pool in a Kubernetes cluster.
173
153
  *
174
154
  * @param request - The request {@link GetPoolRequest}
175
155
  * @returns A Promise of Pool
@@ -184,53 +164,43 @@ export declare class API extends ParentAPI {
184
164
  */
185
165
  waitForPool: (request: Readonly<GetPoolRequest>, options?: Readonly<WaitForOptions<Pool>>) => Promise<Pool>;
186
166
  /**
187
- * Upgrade a Pool in a Cluster. Upgrade the Kubernetes version of a specific
188
- * pool. Note that it only works if the targeted version matches the cluster's
189
- * version. This will drain and replace the nodes in that pool.
167
+ * Upgrade a Pool in a Cluster. Upgrade the Kubernetes version of a specific pool. Note that it only works if the targeted version matches the cluster's version.
168
+ This will drain and replace the nodes in that pool.
190
169
  *
191
170
  * @param request - The request {@link UpgradePoolRequest}
192
171
  * @returns A Promise of Pool
193
172
  */
194
173
  upgradePool: (request: Readonly<UpgradePoolRequest>) => Promise<Pool>;
195
174
  /**
196
- * Update a Pool in a Cluster. Update the attributes of a specific pool, such
197
- * as its desired size, autoscaling settings, and tags. To upgrade a pool, you
198
- * will need to use the dedicated endpoint.
175
+ * Update a Pool in a Cluster. Update the attributes of a specific pool, such as its desired size, autoscaling settings, and tags. To upgrade a pool, you will need to use the dedicated endpoint.
199
176
  *
200
177
  * @param request - The request {@link UpdatePoolRequest}
201
178
  * @returns A Promise of Pool
202
179
  */
203
180
  updatePool: (request: Readonly<UpdatePoolRequest>) => Promise<Pool>;
204
181
  /**
205
- * Delete a Pool in a Cluster. Delete a specific pool from a cluster. Note
206
- * that all the pool's nodes will also be deleted.
182
+ * Delete a Pool in a Cluster. Delete a specific pool from a cluster. Note that all the pool's nodes will also be deleted.
207
183
  *
208
184
  * @param request - The request {@link DeletePoolRequest}
209
185
  * @returns A Promise of Pool
210
186
  */
211
187
  deletePool: (request: Readonly<DeletePoolRequest>) => Promise<Pool>;
212
188
  /**
213
- * Fetch node metadata. Rerieve metadata to instantiate a Kapsule/Kosmos node.
214
- * This method is not intended to be called by end users but rather
215
- * programmatically by the node-installer.
189
+ * Fetch node metadata. Rerieve metadata to instantiate a Kapsule/Kosmos node. This method is not intended to be called by end users but rather programmatically by the node-installer.
216
190
  *
217
191
  * @param request - The request {@link GetNodeMetadataRequest}
218
192
  * @returns A Promise of NodeMetadata
219
193
  */
220
194
  getNodeMetadata: (request?: Readonly<GetNodeMetadataRequest>) => Promise<NodeMetadata>;
221
195
  /**
222
- * Authenticate Kosmos external node. Creates a newer Kosmos node and returns
223
- * its token. This method is not intended to be called by end users but rather
224
- * programmatically by the node-installer.
196
+ * Authenticate Kosmos external node. Creates a newer Kosmos node and returns its token. This method is not intended to be called by end users but rather programmatically by the node-installer.
225
197
  *
226
198
  * @param request - The request {@link AuthExternalNodeRequest}
227
199
  * @returns A Promise of ExternalNodeAuth
228
200
  */
229
201
  authExternalNode: (request: Readonly<AuthExternalNodeRequest>) => Promise<ExternalNodeAuth>;
230
202
  /**
231
- * Create a Kosmos node. Retrieve metadata for a Kosmos node. This method is
232
- * not intended to be called by end users but rather programmatically by the
233
- * kapsule-node-agent.
203
+ * Create a Kosmos node. Retrieve metadata for a Kosmos node. This method is not intended to be called by end users but rather programmatically by the kapsule-node-agent.
234
204
  *
235
205
  * @param request - The request {@link CreateExternalNodeRequest}
236
206
  * @returns A Promise of ExternalNode
@@ -238,8 +208,7 @@ export declare class API extends ParentAPI {
238
208
  createExternalNode: (request: Readonly<CreateExternalNodeRequest>) => Promise<ExternalNode>;
239
209
  protected pageOfListNodes: (request: Readonly<ListNodesRequest>) => Promise<ListNodesResponse>;
240
210
  /**
241
- * List Nodes in a Cluster. List all the existing nodes for a specific
242
- * Kubernetes cluster.
211
+ * List Nodes in a Cluster. List all the existing nodes for a specific Kubernetes cluster.
243
212
  *
244
213
  * @param request - The request {@link ListNodesRequest}
245
214
  * @returns A Promise of ListNodesResponse
@@ -264,11 +233,7 @@ export declare class API extends ParentAPI {
264
233
  */
265
234
  waitForNode: (request: Readonly<GetNodeRequest>, options?: Readonly<WaitForOptions<Node>>) => Promise<Node>;
266
235
  /**
267
- * Replace a Node in a Cluster. Replace a specific Node. The node will first
268
- * be drained and pods will be rescheduled onto another node. Note that when
269
- * there is not enough space to reschedule all the pods (such as in a one-node
270
- * cluster, or with specific constraints), disruption of your applications may
271
- * occur.
236
+ * Replace a Node in a Cluster. Replace a specific Node. The node will first be drained and pods will be rescheduled onto another node. Note that when there is not enough space to reschedule all the pods (such as in a one-node cluster, or with specific constraints), disruption of your applications may occur.
272
237
  *
273
238
  * @deprecated
274
239
  * @param request - The request {@link ReplaceNodeRequest}
@@ -276,30 +241,21 @@ export declare class API extends ParentAPI {
276
241
  */
277
242
  replaceNode: (request: Readonly<ReplaceNodeRequest>) => Promise<Node>;
278
243
  /**
279
- * Reboot a Node in a Cluster. Reboot a specific Node. The node will first be
280
- * drained and pods will be rescheduled onto another node. Note that when
281
- * there is not enough space to reschedule all the pods (such as in a one-node
282
- * cluster, or with specific constraints), disruption of your applications may
283
- * occur.
244
+ * Reboot a Node in a Cluster. Reboot a specific Node. The node will first be drained and pods will be rescheduled onto another node. Note that when there is not enough space to reschedule all the pods (such as in a one-node cluster, or with specific constraints), disruption of your applications may occur.
284
245
  *
285
246
  * @param request - The request {@link RebootNodeRequest}
286
247
  * @returns A Promise of Node
287
248
  */
288
249
  rebootNode: (request: Readonly<RebootNodeRequest>) => Promise<Node>;
289
250
  /**
290
- * Delete a Node in a Cluster. Delete a specific Node. The node will first be
291
- * drained and pods will be rescheduled onto another node. Note that when
292
- * there is not enough space to reschedule all the pods (such as in a one-node
293
- * cluster, or with specific constraints), disruption of your applications may
294
- * occur.
251
+ * Delete a Node in a Cluster. Delete a specific Node. The node will first be drained and pods will be rescheduled onto another node. Note that when there is not enough space to reschedule all the pods (such as in a one-node cluster, or with specific constraints), disruption of your applications may occur.
295
252
  *
296
253
  * @param request - The request {@link DeleteNodeRequest}
297
254
  * @returns A Promise of Node
298
255
  */
299
256
  deleteNode: (request: Readonly<DeleteNodeRequest>) => Promise<Node>;
300
257
  /**
301
- * List all available Versions. List all available versions for the creation
302
- * of a new Kubernetes cluster.
258
+ * List all available Versions. List all available versions for the creation of a new Kubernetes cluster.
303
259
  *
304
260
  * @param request - The request {@link ListVersionsRequest}
305
261
  * @returns A Promise of ListVersionsResponse
@@ -314,8 +270,7 @@ export declare class API extends ParentAPI {
314
270
  getVersion: (request: Readonly<GetVersionRequest>) => Promise<Version>;
315
271
  protected pageOfListClusterTypes: (request?: Readonly<ListClusterTypesRequest>) => Promise<ListClusterTypesResponse>;
316
272
  /**
317
- * List cluster types. List available cluster types and their technical
318
- * details.
273
+ * List cluster types. List available cluster types and their technical details.
319
274
  *
320
275
  * @param request - The request {@link ListClusterTypesRequest}
321
276
  * @returns A Promise of ListClusterTypesResponse