@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
@@ -7,467 +7,744 @@ export type PrivateNetworkProvisioningMode = 'static' | 'ipam';
7
7
  export interface EndpointSpecPrivateNetworkSpecIpamConfig {
8
8
  }
9
9
  export interface PrivateNetwork {
10
- /** UUID of the Private Network. */
10
+ /**
11
+ * UUID of the Private Network.
12
+ */
11
13
  id: string;
12
- /** List of IPv4 CIDR notation addresses of the endpoint. */
14
+ /**
15
+ * List of IPv4 CIDR notation addresses of the endpoint.
16
+ */
13
17
  serviceIps: string[];
14
- /** Zone of the Private Network. */
18
+ /**
19
+ * Zone of the Private Network.
20
+ */
15
21
  zone: ScwZone;
16
- /** How your endpoint ips are provisioned. */
22
+ /**
23
+ * How your endpoint ips are provisioned.
24
+ */
17
25
  provisioningMode: PrivateNetworkProvisioningMode;
18
26
  }
19
27
  export interface PublicNetwork {
20
28
  }
21
29
  export interface EndpointSpecPrivateNetworkSpec {
22
- /** UUID of the Private Network to connect to the Database Instance. */
30
+ /**
31
+ * UUID of the Private Network to connect to the Database Instance.
32
+ */
23
33
  id: string;
24
34
  /**
25
- * Endpoint IPv4 address with a CIDR notation. You must provide at least one
26
- * IPv4 per node.
35
+ * Endpoint IPv4 address with a CIDR notation. You must provide at least one IPv4 per node.
27
36
  */
28
37
  serviceIps: string[];
29
38
  /**
30
- * Automated configuration of your Private Network endpoint with Scaleway IPAM
31
- * service.
39
+ * Automated configuration of your Private Network endpoint with Scaleway IPAM service.
32
40
  */
33
41
  ipamConfig?: EndpointSpecPrivateNetworkSpecIpamConfig;
34
42
  }
35
43
  export interface EndpointSpecPublicNetworkSpec {
36
44
  }
37
45
  export interface AvailableClusterSetting {
38
- /** Name of the setting. */
46
+ /**
47
+ * Name of the setting.
48
+ */
39
49
  name: string;
40
- /** Default value of the setting. */
50
+ /**
51
+ * Default value of the setting.
52
+ */
41
53
  defaultValue?: string;
42
- /** Type of setting. */
54
+ /**
55
+ * Type of setting.
56
+ */
43
57
  type: AvailableClusterSettingPropertyType;
44
- /** Description of the setting. */
58
+ /**
59
+ * Description of the setting.
60
+ */
45
61
  description: string;
46
- /** Optional maximum value of the setting. */
62
+ /**
63
+ * Optional maximum value of the setting.
64
+ */
47
65
  maxValue?: number;
48
- /** Optional minimum value of the setting. */
66
+ /**
67
+ * Optional minimum value of the setting.
68
+ */
49
69
  minValue?: number;
50
- /** Optional validation rule of the setting. */
70
+ /**
71
+ * Optional validation rule of the setting.
72
+ */
51
73
  regex?: string;
52
- /** Defines whether or not the setting is deprecated. */
74
+ /**
75
+ * Defines whether or not the setting is deprecated.
76
+ */
53
77
  deprecated: boolean;
54
78
  }
55
79
  export interface ACLRule {
56
- /** ID of the rule. */
80
+ /**
81
+ * ID of the rule.
82
+ */
57
83
  id: string;
58
- /** IPv4 network address of the rule. */
84
+ /**
85
+ * IPv4 network address of the rule.
86
+ */
59
87
  ipCidr?: string;
60
- /** Description of the rule. */
88
+ /**
89
+ * Description of the rule.
90
+ */
61
91
  description?: string;
62
92
  }
63
93
  export interface ClusterSetting {
64
- /** Value of the setting. */
94
+ /**
95
+ * Value of the setting.
96
+ */
65
97
  value: string;
66
- /** Name of the setting. */
98
+ /**
99
+ * Name of the setting.
100
+ */
67
101
  name: string;
68
102
  }
69
103
  export interface Endpoint {
70
- /** TCP port of the endpoint. */
104
+ /**
105
+ * TCP port of the endpoint.
106
+ */
71
107
  port: number;
72
108
  /**
73
109
  * Private Network details.
74
110
  *
75
- * One-of ('details'): at most one of 'privateNetwork', 'publicNetwork' could
76
- * be set.
111
+ * One-of ('details'): at most one of 'privateNetwork', 'publicNetwork' could be set.
77
112
  */
78
113
  privateNetwork?: PrivateNetwork;
79
114
  /**
80
115
  * Public network details.
81
116
  *
82
- * One-of ('details'): at most one of 'privateNetwork', 'publicNetwork' could
83
- * be set.
117
+ * One-of ('details'): at most one of 'privateNetwork', 'publicNetwork' could be set.
84
118
  */
85
119
  publicNetwork?: PublicNetwork;
86
- /** List of IPv4 addresses of the endpoint. */
120
+ /**
121
+ * List of IPv4 addresses of the endpoint.
122
+ */
87
123
  ips: string[];
88
- /** UUID of the endpoint. */
124
+ /**
125
+ * UUID of the endpoint.
126
+ */
89
127
  id: string;
90
128
  }
91
129
  export interface ACLRuleSpec {
92
- /** IPv4 network address of the rule. */
130
+ /**
131
+ * IPv4 network address of the rule.
132
+ */
93
133
  ipCidr: string;
94
- /** Description of the rule. */
134
+ /**
135
+ * Description of the rule.
136
+ */
95
137
  description: string;
96
138
  }
97
139
  export interface EndpointSpec {
98
140
  /**
99
141
  * Private Network specification details.
100
142
  *
101
- * One-of ('endpointType'): at most one of 'privateNetwork', 'publicNetwork'
102
- * could be set.
143
+ * One-of ('endpointType'): at most one of 'privateNetwork', 'publicNetwork' could be set.
103
144
  */
104
145
  privateNetwork?: EndpointSpecPrivateNetworkSpec;
105
146
  /**
106
147
  * Public network specification details.
107
148
  *
108
- * One-of ('endpointType'): at most one of 'privateNetwork', 'publicNetwork'
109
- * could be set.
149
+ * One-of ('endpointType'): at most one of 'privateNetwork', 'publicNetwork' could be set.
110
150
  */
111
151
  publicNetwork?: EndpointSpecPublicNetworkSpec;
112
152
  }
113
153
  export interface ClusterVersion {
114
- /** Redis™ engine version. */
154
+ /**
155
+ * Redis™ engine version.
156
+ */
115
157
  version: string;
116
- /** Date of End of Life. */
158
+ /**
159
+ * Date of End of Life.
160
+ */
117
161
  endOfLifeAt?: Date;
118
- /** Cluster settings available to be updated. */
162
+ /**
163
+ * Cluster settings available to be updated.
164
+ */
119
165
  availableSettings: AvailableClusterSetting[];
120
- /** Redis™ logo url. */
166
+ /**
167
+ * Redis™ logo url.
168
+ */
121
169
  logoUrl: string;
122
- /** Zone of the Redis™ Database Instance. */
170
+ /**
171
+ * Zone of the Redis™ Database Instance.
172
+ */
123
173
  zone: ScwZone;
124
174
  }
125
175
  export interface Cluster {
126
- /** UUID of the Database Instance. */
176
+ /**
177
+ * UUID of the Database Instance.
178
+ */
127
179
  id: string;
128
- /** Name of the Database Instance. */
180
+ /**
181
+ * Name of the Database Instance.
182
+ */
129
183
  name: string;
130
- /** Project ID the Database Instance belongs to. */
184
+ /**
185
+ * Project ID the Database Instance belongs to.
186
+ */
131
187
  projectId: string;
132
- /** Status of the Database Instance. */
188
+ /**
189
+ * Status of the Database Instance.
190
+ */
133
191
  status: ClusterStatus;
134
- /** Redis™ engine version of the Database Instance. */
192
+ /**
193
+ * Redis™ engine version of the Database Instance.
194
+ */
135
195
  version: string;
136
- /** List of Database Instance endpoints. */
196
+ /**
197
+ * List of Database Instance endpoints.
198
+ */
137
199
  endpoints: Endpoint[];
138
- /** List of tags applied to the Database Instance. */
200
+ /**
201
+ * List of tags applied to the Database Instance.
202
+ */
139
203
  tags: string[];
140
- /** Node type of the Database Instance. */
204
+ /**
205
+ * Node type of the Database Instance.
206
+ */
141
207
  nodeType: string;
142
- /** Creation date (Format ISO 8601). */
208
+ /**
209
+ * Creation date (Format ISO 8601).
210
+ */
143
211
  createdAt?: Date;
144
- /** Update date (Format ISO 8601). */
212
+ /**
213
+ * Update date (Format ISO 8601).
214
+ */
145
215
  updatedAt?: Date;
146
- /** Defines whether or not TLS is enabled. */
216
+ /**
217
+ * Defines whether or not TLS is enabled.
218
+ */
147
219
  tlsEnabled: boolean;
148
- /** List of Database Instance settings. */
220
+ /**
221
+ * List of Database Instance settings.
222
+ */
149
223
  clusterSettings: ClusterSetting[];
150
- /** List of ACL rules. */
224
+ /**
225
+ * List of ACL rules.
226
+ */
151
227
  aclRules: ACLRule[];
152
- /** Number of nodes of the Database Instance cluster. */
228
+ /**
229
+ * Number of nodes of the Database Instance cluster.
230
+ */
153
231
  clusterSize: number;
154
- /** Zone of the Database Instance. */
232
+ /**
233
+ * Zone of the Database Instance.
234
+ */
155
235
  zone: ScwZone;
156
- /** Name of the user associated to the cluster. */
236
+ /**
237
+ * Name of the user associated to the cluster.
238
+ */
157
239
  userName: string;
158
- /** List of engine versions the Database Instance can upgrade to. */
240
+ /**
241
+ * List of engine versions the Database Instance can upgrade to.
242
+ */
159
243
  upgradableVersions: string[];
160
244
  }
161
245
  export interface NodeType {
162
- /** Node type name. */
246
+ /**
247
+ * Node type name.
248
+ */
163
249
  name: string;
164
- /** Current stock status of the node type. */
250
+ /**
251
+ * Current stock status of the node type.
252
+ */
165
253
  stockStatus: NodeTypeStock;
166
- /** Current specifications of the offer. */
254
+ /**
255
+ * Current specifications of the offer.
256
+ */
167
257
  description: string;
168
- /** Number of virtual CPUs. */
258
+ /**
259
+ * Number of virtual CPUs.
260
+ */
169
261
  vcpus: number;
170
- /** Quantity of RAM. */
262
+ /**
263
+ * Quantity of RAM.
264
+ */
171
265
  memory: number;
172
- /** Defines whether node type is currently disabled or not. */
266
+ /**
267
+ * Defines whether node type is currently disabled or not.
268
+ */
173
269
  disabled: boolean;
174
- /** Defines whether node type is currently in beta. */
270
+ /**
271
+ * Defines whether node type is currently in beta.
272
+ */
175
273
  beta: boolean;
176
- /** Zone of the node type. */
274
+ /**
275
+ * Zone of the node type.
276
+ */
177
277
  zone: ScwZone;
178
278
  }
179
279
  export type AddAclRulesRequest = {
180
- /** Zone to target. If none is passed will use default zone from the config. */
280
+ /**
281
+ * Zone to target. If none is passed will use default zone from the config.
282
+ */
181
283
  zone?: ScwZone;
182
- /** UUID of the Database Instance you want to add ACL rules to. */
284
+ /**
285
+ * UUID of the Database Instance you want to add ACL rules to.
286
+ */
183
287
  clusterId: string;
184
- /** ACLs rules to add to the cluster. */
288
+ /**
289
+ * ACLs rules to add to the cluster.
290
+ */
185
291
  aclRules: ACLRuleSpec[];
186
292
  };
187
293
  export interface AddAclRulesResponse {
188
- /** ACL Rules enabled for the Database Instance. */
294
+ /**
295
+ * ACL Rules enabled for the Database Instance.
296
+ */
189
297
  aclRules: ACLRule[];
190
- /** Total count of ACL rules of the Database Instance. */
298
+ /**
299
+ * Total count of ACL rules of the Database Instance.
300
+ */
191
301
  totalCount: number;
192
302
  }
193
303
  export type AddClusterSettingsRequest = {
194
- /** Zone to target. If none is passed will use default zone from the config. */
304
+ /**
305
+ * Zone to target. If none is passed will use default zone from the config.
306
+ */
195
307
  zone?: ScwZone;
196
- /** UUID of the Database Instance you want to add settings to. */
308
+ /**
309
+ * UUID of the Database Instance you want to add settings to.
310
+ */
197
311
  clusterId: string;
198
- /** Settings to add to the cluster. */
312
+ /**
313
+ * Settings to add to the cluster.
314
+ */
199
315
  settings: ClusterSetting[];
200
316
  };
201
317
  export type AddEndpointsRequest = {
202
- /** Zone to target. If none is passed will use default zone from the config. */
318
+ /**
319
+ * Zone to target. If none is passed will use default zone from the config.
320
+ */
203
321
  zone?: ScwZone;
204
- /** UUID of the Database Instance you want to add endpoints to. */
322
+ /**
323
+ * UUID of the Database Instance you want to add endpoints to.
324
+ */
205
325
  clusterId: string;
206
- /** Endpoints to add to the Database Instance. */
326
+ /**
327
+ * Endpoints to add to the Database Instance.
328
+ */
207
329
  endpoints: EndpointSpec[];
208
330
  };
209
331
  export interface AddEndpointsResponse {
210
- /** Endpoints defined on the Database Instance. */
332
+ /**
333
+ * Endpoints defined on the Database Instance.
334
+ */
211
335
  endpoints: Endpoint[];
212
- /** Total count of endpoints of the Database Instance. */
336
+ /**
337
+ * Total count of endpoints of the Database Instance.
338
+ */
213
339
  totalCount: number;
214
340
  }
215
341
  export interface ClusterMetricsResponse {
216
- /** Time series of metrics of a given cluster. */
342
+ /**
343
+ * Time series of metrics of a given cluster.
344
+ */
217
345
  timeseries: TimeSeries[];
218
346
  }
219
347
  export interface ClusterSettingsResponse {
220
- /** Settings configured for a given Database Instance. */
348
+ /**
349
+ * Settings configured for a given Database Instance.
350
+ */
221
351
  settings: ClusterSetting[];
222
352
  }
223
353
  export type CreateClusterRequest = {
224
- /** Zone to target. If none is passed will use default zone from the config. */
354
+ /**
355
+ * Zone to target. If none is passed will use default zone from the config.
356
+ */
225
357
  zone?: ScwZone;
226
- /** Project ID in which to create the Database Instance. */
358
+ /**
359
+ * Project ID in which to create the Database Instance.
360
+ */
227
361
  projectId?: string;
228
- /** Name of the Database Instance. */
362
+ /**
363
+ * Name of the Database Instance.
364
+ */
229
365
  name?: string;
230
- /** Redis™ engine version of the Database Instance. */
366
+ /**
367
+ * Redis™ engine version of the Database Instance.
368
+ */
231
369
  version: string;
232
- /** Tags to apply to the Database Instance. */
370
+ /**
371
+ * Tags to apply to the Database Instance.
372
+ */
233
373
  tags?: string[];
234
- /** Type of node to use for the Database Instance. */
374
+ /**
375
+ * Type of node to use for the Database Instance.
376
+ */
235
377
  nodeType: string;
236
- /** Name of the user created upon Database Instance creation. */
378
+ /**
379
+ * Name of the user created upon Database Instance creation.
380
+ */
237
381
  userName: string;
238
- /** Password of the user. */
382
+ /**
383
+ * Password of the user.
384
+ */
239
385
  password: string;
240
- /** Number of nodes in the Redis™ cluster. */
386
+ /**
387
+ * Number of nodes in the Redis™ cluster.
388
+ */
241
389
  clusterSize?: number;
242
- /** List of ACLRuleSpec used to secure your publicly exposed cluster. */
390
+ /**
391
+ * List of ACLRuleSpec used to secure your publicly exposed cluster.
392
+ */
243
393
  aclRules?: ACLRuleSpec[];
244
394
  /**
245
- * Zero or multiple EndpointSpec used to expose your cluster publicly and
246
- * inside private networks. If no EndpoindSpec is given the cluster will be
247
- * publicly exposed by default.
395
+ * Zero or multiple EndpointSpec used to expose your cluster publicly and inside private networks. If no EndpoindSpec is given the cluster will be publicly exposed by default.
248
396
  */
249
397
  endpoints?: EndpointSpec[];
250
- /** Defines whether or not TLS is enabled. */
398
+ /**
399
+ * Defines whether or not TLS is enabled.
400
+ */
251
401
  tlsEnabled: boolean;
252
- /** List of advanced settings to be set upon Database Instance initialization. */
402
+ /**
403
+ * List of advanced settings to be set upon Database Instance initialization.
404
+ */
253
405
  clusterSettings?: ClusterSetting[];
254
406
  };
255
407
  export type DeleteAclRuleRequest = {
256
- /** Zone to target. If none is passed will use default zone from the config. */
408
+ /**
409
+ * Zone to target. If none is passed will use default zone from the config.
410
+ */
257
411
  zone?: ScwZone;
258
- /** UUID of the ACL rule you want to delete. */
412
+ /**
413
+ * UUID of the ACL rule you want to delete.
414
+ */
259
415
  aclId: string;
260
416
  };
261
417
  export type DeleteClusterRequest = {
262
- /** Zone to target. If none is passed will use default zone from the config. */
418
+ /**
419
+ * Zone to target. If none is passed will use default zone from the config.
420
+ */
263
421
  zone?: ScwZone;
264
- /** UUID of the Database Instance to delete. */
422
+ /**
423
+ * UUID of the Database Instance to delete.
424
+ */
265
425
  clusterId: string;
266
426
  };
267
427
  export type DeleteClusterSettingRequest = {
268
- /** Zone to target. If none is passed will use default zone from the config. */
428
+ /**
429
+ * Zone to target. If none is passed will use default zone from the config.
430
+ */
269
431
  zone?: ScwZone;
270
- /** UUID of the Database Instance where the settings must be set. */
432
+ /**
433
+ * UUID of the Database Instance where the settings must be set.
434
+ */
271
435
  clusterId: string;
272
- /** Setting name to delete. */
436
+ /**
437
+ * Setting name to delete.
438
+ */
273
439
  settingName: string;
274
440
  };
275
441
  export type DeleteEndpointRequest = {
276
- /** Zone to target. If none is passed will use default zone from the config. */
442
+ /**
443
+ * Zone to target. If none is passed will use default zone from the config.
444
+ */
277
445
  zone?: ScwZone;
278
- /** UUID of the endpoint you want to delete. */
446
+ /**
447
+ * UUID of the endpoint you want to delete.
448
+ */
279
449
  endpointId: string;
280
450
  };
281
451
  export type GetAclRuleRequest = {
282
- /** Zone to target. If none is passed will use default zone from the config. */
452
+ /**
453
+ * Zone to target. If none is passed will use default zone from the config.
454
+ */
283
455
  zone?: ScwZone;
284
- /** UUID of the ACL rule you want to get. */
456
+ /**
457
+ * UUID of the ACL rule you want to get.
458
+ */
285
459
  aclId: string;
286
460
  };
287
461
  export type GetClusterCertificateRequest = {
288
- /** Zone to target. If none is passed will use default zone from the config. */
462
+ /**
463
+ * Zone to target. If none is passed will use default zone from the config.
464
+ */
289
465
  zone?: ScwZone;
290
- /** UUID of the cluster. */
466
+ /**
467
+ * UUID of the cluster.
468
+ */
291
469
  clusterId: string;
292
470
  };
293
471
  export type GetClusterMetricsRequest = {
294
- /** Zone to target. If none is passed will use default zone from the config. */
472
+ /**
473
+ * Zone to target. If none is passed will use default zone from the config.
474
+ */
295
475
  zone?: ScwZone;
296
- /** UUID of the cluster. */
476
+ /**
477
+ * UUID of the cluster.
478
+ */
297
479
  clusterId: string;
298
- /** Start date. */
480
+ /**
481
+ * Start date.
482
+ */
299
483
  startAt?: Date;
300
- /** End date. */
484
+ /**
485
+ * End date.
486
+ */
301
487
  endAt?: Date;
302
- /** Name of the metric to gather. */
488
+ /**
489
+ * Name of the metric to gather.
490
+ */
303
491
  metricName?: string;
304
492
  };
305
493
  export type GetClusterRequest = {
306
- /** Zone to target. If none is passed will use default zone from the config. */
494
+ /**
495
+ * Zone to target. If none is passed will use default zone from the config.
496
+ */
307
497
  zone?: ScwZone;
308
- /** UUID of the cluster. */
498
+ /**
499
+ * UUID of the cluster.
500
+ */
309
501
  clusterId: string;
310
502
  };
311
503
  export type GetEndpointRequest = {
312
- /** Zone to target. If none is passed will use default zone from the config. */
504
+ /**
505
+ * Zone to target. If none is passed will use default zone from the config.
506
+ */
313
507
  zone?: ScwZone;
314
- /** UUID of the endpoint you want to get. */
508
+ /**
509
+ * UUID of the endpoint you want to get.
510
+ */
315
511
  endpointId: string;
316
512
  };
317
513
  export type ListClusterVersionsRequest = {
318
- /** Zone to target. If none is passed will use default zone from the config. */
514
+ /**
515
+ * Zone to target. If none is passed will use default zone from the config.
516
+ */
319
517
  zone?: ScwZone;
320
- /** Defines whether or not to include disabled Redis™ engine versions. */
518
+ /**
519
+ * Defines whether or not to include disabled Redis™ engine versions.
520
+ */
321
521
  includeDisabled: boolean;
322
- /** Defines whether or not to include beta Redis™ engine versions. */
522
+ /**
523
+ * Defines whether or not to include beta Redis™ engine versions.
524
+ */
323
525
  includeBeta: boolean;
324
- /** Defines whether or not to include deprecated Redis™ engine versions. */
526
+ /**
527
+ * Defines whether or not to include deprecated Redis™ engine versions.
528
+ */
325
529
  includeDeprecated: boolean;
326
- /** List Redis™ engine versions that match a given name pattern. */
530
+ /**
531
+ * List Redis™ engine versions that match a given name pattern.
532
+ */
327
533
  version?: string;
328
534
  page?: number;
329
535
  pageSize?: number;
330
536
  };
331
537
  export interface ListClusterVersionsResponse {
332
- /** List of available Redis™ engine versions. */
538
+ /**
539
+ * List of available Redis™ engine versions.
540
+ */
333
541
  versions: ClusterVersion[];
334
- /** Total count of available Redis™ engine versions. */
542
+ /**
543
+ * Total count of available Redis™ engine versions.
544
+ */
335
545
  totalCount: number;
336
546
  }
337
547
  export type ListClustersRequest = {
338
- /** Zone to target. If none is passed will use default zone from the config. */
548
+ /**
549
+ * Zone to target. If none is passed will use default zone from the config.
550
+ */
339
551
  zone?: ScwZone;
340
- /** Filter by Database Instance tags. */
552
+ /**
553
+ * Filter by Database Instance tags.
554
+ */
341
555
  tags?: string[];
342
- /** Filter by Database Instance names. */
556
+ /**
557
+ * Filter by Database Instance names.
558
+ */
343
559
  name?: string;
344
- /** Criteria to use when ordering the list. */
560
+ /**
561
+ * Criteria to use when ordering the list.
562
+ */
345
563
  orderBy?: ListClustersRequestOrderBy;
346
- /** Filter by Project ID. */
564
+ /**
565
+ * Filter by Project ID.
566
+ */
347
567
  projectId?: string;
348
- /** Filter by Organization ID. */
568
+ /**
569
+ * Filter by Organization ID.
570
+ */
349
571
  organizationId?: string;
350
- /** Filter by Redis™ engine version. */
572
+ /**
573
+ * Filter by Redis™ engine version.
574
+ */
351
575
  version?: string;
352
576
  page?: number;
353
577
  pageSize?: number;
354
578
  };
355
579
  export interface ListClustersResponse {
356
- /** List all Database Instances. */
580
+ /**
581
+ * List all Database Instances.
582
+ */
357
583
  clusters: Cluster[];
358
- /** Total count of Database Instances. */
584
+ /**
585
+ * Total count of Database Instances.
586
+ */
359
587
  totalCount: number;
360
588
  }
361
589
  export type ListNodeTypesRequest = {
362
- /** Zone to target. If none is passed will use default zone from the config. */
590
+ /**
591
+ * Zone to target. If none is passed will use default zone from the config.
592
+ */
363
593
  zone?: ScwZone;
364
- /** Defines whether or not to include disabled types. */
594
+ /**
595
+ * Defines whether or not to include disabled types.
596
+ */
365
597
  includeDisabledTypes: boolean;
366
598
  page?: number;
367
599
  pageSize?: number;
368
600
  };
369
601
  export interface ListNodeTypesResponse {
370
- /** Types of node. */
602
+ /**
603
+ * Types of node.
604
+ */
371
605
  nodeTypes: NodeType[];
372
- /** Total count of node types available. */
606
+ /**
607
+ * Total count of node types available.
608
+ */
373
609
  totalCount: number;
374
610
  }
375
611
  export type MigrateClusterRequest = {
376
- /** Zone to target. If none is passed will use default zone from the config. */
612
+ /**
613
+ * Zone to target. If none is passed will use default zone from the config.
614
+ */
377
615
  zone?: ScwZone;
378
- /** UUID of the Database Instance to update. */
616
+ /**
617
+ * UUID of the Database Instance to update.
618
+ */
379
619
  clusterId: string;
380
620
  /**
381
621
  * Redis™ engine version of the Database Instance.
382
622
  *
383
- * One-of ('action'): at most one of 'version', 'nodeType', 'clusterSize'
384
- * could be set.
623
+ * One-of ('action'): at most one of 'version', 'nodeType', 'clusterSize' could be set.
385
624
  */
386
625
  version?: string;
387
626
  /**
388
627
  * Type of node to use for the Database Instance.
389
628
  *
390
- * One-of ('action'): at most one of 'version', 'nodeType', 'clusterSize'
391
- * could be set.
629
+ * One-of ('action'): at most one of 'version', 'nodeType', 'clusterSize' could be set.
392
630
  */
393
631
  nodeType?: string;
394
632
  /**
395
633
  * Number of nodes for the Database Instance.
396
634
  *
397
- * One-of ('action'): at most one of 'version', 'nodeType', 'clusterSize'
398
- * could be set.
635
+ * One-of ('action'): at most one of 'version', 'nodeType', 'clusterSize' could be set.
399
636
  */
400
637
  clusterSize?: number;
401
638
  };
402
639
  export type RenewClusterCertificateRequest = {
403
- /** Zone to target. If none is passed will use default zone from the config. */
640
+ /**
641
+ * Zone to target. If none is passed will use default zone from the config.
642
+ */
404
643
  zone?: ScwZone;
405
- /** UUID of the cluster. */
644
+ /**
645
+ * UUID of the cluster.
646
+ */
406
647
  clusterId: string;
407
648
  };
408
649
  export type SetAclRulesRequest = {
409
- /** Zone to target. If none is passed will use default zone from the config. */
650
+ /**
651
+ * Zone to target. If none is passed will use default zone from the config.
652
+ */
410
653
  zone?: ScwZone;
411
- /** UUID of the Database Instance where the ACL rules have to be set. */
654
+ /**
655
+ * UUID of the Database Instance where the ACL rules have to be set.
656
+ */
412
657
  clusterId: string;
413
- /** ACLs rules to define for the cluster. */
658
+ /**
659
+ * ACLs rules to define for the cluster.
660
+ */
414
661
  aclRules: ACLRuleSpec[];
415
662
  };
416
663
  export interface SetAclRulesResponse {
417
- /** ACL Rules enabled for the Database Instance. */
664
+ /**
665
+ * ACL Rules enabled for the Database Instance.
666
+ */
418
667
  aclRules: ACLRule[];
419
668
  }
420
669
  export type SetClusterSettingsRequest = {
421
- /** Zone to target. If none is passed will use default zone from the config. */
670
+ /**
671
+ * Zone to target. If none is passed will use default zone from the config.
672
+ */
422
673
  zone?: ScwZone;
423
- /** UUID of the Database Instance where the settings must be set. */
674
+ /**
675
+ * UUID of the Database Instance where the settings must be set.
676
+ */
424
677
  clusterId: string;
425
- /** Settings to define for the Database Instance. */
678
+ /**
679
+ * Settings to define for the Database Instance.
680
+ */
426
681
  settings: ClusterSetting[];
427
682
  };
428
683
  export type SetEndpointsRequest = {
429
- /** Zone to target. If none is passed will use default zone from the config. */
684
+ /**
685
+ * Zone to target. If none is passed will use default zone from the config.
686
+ */
430
687
  zone?: ScwZone;
431
- /** UUID of the Database Instance where the endpoints have to be set. */
688
+ /**
689
+ * UUID of the Database Instance where the endpoints have to be set.
690
+ */
432
691
  clusterId: string;
433
- /** Endpoints to define for the Database Instance. */
692
+ /**
693
+ * Endpoints to define for the Database Instance.
694
+ */
434
695
  endpoints: EndpointSpec[];
435
696
  };
436
697
  export interface SetEndpointsResponse {
437
- /** Endpoints defined on the Database Instance. */
698
+ /**
699
+ * Endpoints defined on the Database Instance.
700
+ */
438
701
  endpoints: Endpoint[];
439
702
  }
440
703
  export type UpdateClusterRequest = {
441
- /** Zone to target. If none is passed will use default zone from the config. */
704
+ /**
705
+ * Zone to target. If none is passed will use default zone from the config.
706
+ */
442
707
  zone?: ScwZone;
443
- /** UUID of the Database Instance to update. */
708
+ /**
709
+ * UUID of the Database Instance to update.
710
+ */
444
711
  clusterId: string;
445
- /** Name of the Database Instance. */
712
+ /**
713
+ * Name of the Database Instance.
714
+ */
446
715
  name?: string;
447
- /** Database Instance tags. */
716
+ /**
717
+ * Database Instance tags.
718
+ */
448
719
  tags?: string[];
449
- /** Name of the Database Instance user. */
720
+ /**
721
+ * Name of the Database Instance user.
722
+ */
450
723
  userName?: string;
451
- /** Password of the Database Instance user. */
724
+ /**
725
+ * Password of the Database Instance user.
726
+ */
452
727
  password?: string;
453
728
  };
454
729
  export type UpdateEndpointRequest = {
455
- /** Zone to target. If none is passed will use default zone from the config. */
730
+ /**
731
+ * Zone to target. If none is passed will use default zone from the config.
732
+ */
456
733
  zone?: ScwZone;
457
- /** UUID of the endpoint you want to get. */
734
+ /**
735
+ * UUID of the endpoint you want to get.
736
+ */
458
737
  endpointId: string;
459
738
  /**
460
739
  * Private Network details.
461
740
  *
462
- * One-of ('endpointType'): at most one of 'privateNetwork', 'publicNetwork'
463
- * could be set.
741
+ * One-of ('endpointType'): at most one of 'privateNetwork', 'publicNetwork' could be set.
464
742
  */
465
743
  privateNetwork?: EndpointSpecPrivateNetworkSpec;
466
744
  /**
467
745
  * Public network details.
468
746
  *
469
- * One-of ('endpointType'): at most one of 'privateNetwork', 'publicNetwork'
470
- * could be set.
747
+ * One-of ('endpointType'): at most one of 'privateNetwork', 'publicNetwork' could be set.
471
748
  */
472
749
  publicNetwork?: EndpointSpecPublicNetworkSpec;
473
750
  };