@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.
- package/dist/api/account/v3/api.gen.cjs +13 -32
- package/dist/api/account/v3/api.gen.d.ts +17 -36
- package/dist/api/account/v3/api.gen.js +13 -32
- package/dist/api/account/v3/types.gen.d.ts +187 -85
- package/dist/api/applesilicon/v1alpha1/api.gen.cjs +19 -46
- package/dist/api/applesilicon/v1alpha1/api.gen.d.ts +24 -49
- package/dist/api/applesilicon/v1alpha1/api.gen.js +19 -46
- package/dist/api/applesilicon/v1alpha1/types.gen.d.ts +310 -135
- package/dist/api/audit_trail/v1alpha1/api.gen.cjs +2 -5
- package/dist/api/audit_trail/v1alpha1/api.gen.d.ts +4 -8
- package/dist/api/audit_trail/v1alpha1/api.gen.js +2 -5
- package/dist/api/audit_trail/v1alpha1/types.gen.d.ts +110 -82
- package/dist/api/baremetal/v1/api.gen.cjs +28 -61
- package/dist/api/baremetal/v1/api.gen.d.ts +29 -60
- package/dist/api/baremetal/v1/api.gen.js +28 -61
- package/dist/api/baremetal/v1/types.gen.d.ts +802 -315
- package/dist/api/baremetal/v3/api.gen.cjs +7 -14
- package/dist/api/baremetal/v3/api.gen.d.ts +10 -15
- package/dist/api/baremetal/v3/api.gen.js +7 -14
- package/dist/api/baremetal/v3/types.gen.d.ts +82 -32
- package/dist/api/billing/v2beta1/api.gen.cjs +11 -20
- package/dist/api/billing/v2beta1/api.gen.d.ts +9 -19
- package/dist/api/billing/v2beta1/api.gen.js +11 -20
- package/dist/api/billing/v2beta1/types.gen.d.ts +231 -102
- package/dist/api/block/v1/api.gen.cjs +37 -55
- package/dist/api/block/v1/api.gen.d.ts +19 -37
- package/dist/api/block/v1/api.gen.js +37 -55
- package/dist/api/block/v1/types.gen.d.ts +306 -125
- package/dist/api/block/v1alpha1/api.gen.cjs +45 -64
- package/dist/api/block/v1alpha1/api.gen.d.ts +22 -41
- package/dist/api/block/v1alpha1/api.gen.js +45 -64
- package/dist/api/block/v1alpha1/types.gen.d.ts +327 -132
- package/dist/api/cockpit/v1/api.gen.cjs +100 -156
- package/dist/api/cockpit/v1/api.gen.d.ts +53 -112
- package/dist/api/cockpit/v1/api.gen.js +100 -156
- package/dist/api/cockpit/v1/types.gen.d.ts +567 -246
- package/dist/api/container/v1beta1/api.gen.cjs +7 -14
- package/dist/api/container/v1beta1/api.gen.d.ts +9 -16
- package/dist/api/container/v1beta1/api.gen.js +7 -14
- package/dist/api/container/v1beta1/types.gen.d.ts +648 -322
- package/dist/api/dedibox/v1/api.gen.cjs +45 -69
- package/dist/api/dedibox/v1/api.gen.d.ts +52 -62
- package/dist/api/dedibox/v1/api.gen.js +45 -69
- package/dist/api/dedibox/v1/types.gen.d.ts +1765 -645
- package/dist/api/domain/v2beta1/api.gen.cjs +119 -178
- package/dist/api/domain/v2beta1/api.gen.d.ts +71 -130
- package/dist/api/domain/v2beta1/api.gen.js +119 -178
- package/dist/api/domain/v2beta1/content.gen.d.ts +1 -4
- package/dist/api/domain/v2beta1/types.gen.d.ts +411 -199
- package/dist/api/flexibleip/v1alpha1/api.gen.cjs +10 -25
- package/dist/api/flexibleip/v1alpha1/api.gen.d.ts +12 -28
- package/dist/api/flexibleip/v1alpha1/api.gen.js +10 -25
- package/dist/api/flexibleip/v1alpha1/types.gen.d.ts +186 -78
- package/dist/api/inference/v1/api.gen.cjs +8 -11
- package/dist/api/inference/v1/api.gen.d.ts +6 -9
- package/dist/api/inference/v1/api.gen.js +8 -11
- package/dist/api/inference/v1/types.gen.d.ts +330 -150
- package/dist/api/inference/v1beta1/api.gen.cjs +8 -11
- package/dist/api/inference/v1beta1/api.gen.d.ts +6 -9
- package/dist/api/inference/v1beta1/api.gen.js +8 -11
- package/dist/api/inference/v1beta1/types.gen.d.ts +341 -154
- package/dist/api/instance/v1/api.gen.cjs +64 -113
- package/dist/api/instance/v1/api.gen.d.ts +54 -103
- package/dist/api/instance/v1/api.gen.js +64 -113
- package/dist/api/instance/v1/types.gen.d.ts +1351 -598
- package/dist/api/instance/v1/types.private.gen.d.ts +131 -59
- package/dist/api/interlink/v1beta1/api.gen.cjs +21 -67
- package/dist/api/interlink/v1beta1/api.gen.d.ts +23 -70
- package/dist/api/interlink/v1beta1/api.gen.js +21 -67
- package/dist/api/interlink/v1beta1/marshalling.gen.cjs +2 -0
- package/dist/api/interlink/v1beta1/marshalling.gen.js +2 -0
- package/dist/api/interlink/v1beta1/types.gen.d.ts +464 -216
- package/dist/api/interlink/v1beta1/validation-rules.gen.cjs +8 -0
- package/dist/api/interlink/v1beta1/validation-rules.gen.d.ts +8 -0
- package/dist/api/interlink/v1beta1/validation-rules.gen.js +8 -0
- package/dist/api/iot/v1/api.gen.cjs +37 -70
- package/dist/api/iot/v1/api.gen.d.ts +34 -67
- package/dist/api/iot/v1/api.gen.js +37 -70
- package/dist/api/iot/v1/types.gen.d.ts +566 -321
- package/dist/api/ipam/v1/api.gen.cjs +6 -26
- package/dist/api/ipam/v1/api.gen.d.ts +8 -29
- package/dist/api/ipam/v1/api.gen.js +6 -26
- package/dist/api/ipam/v1/types.gen.d.ts +146 -105
- package/dist/api/jobs/v1alpha1/api.gen.cjs +2 -4
- package/dist/api/jobs/v1alpha1/api.gen.d.ts +4 -6
- package/dist/api/jobs/v1alpha1/api.gen.js +2 -4
- package/dist/api/jobs/v1alpha1/types.gen.d.ts +165 -91
- package/dist/api/k8s/v1/api.gen.cjs +33 -78
- package/dist/api/k8s/v1/api.gen.d.ts +27 -72
- package/dist/api/k8s/v1/api.gen.js +33 -78
- package/dist/api/k8s/v1/types.gen.d.ts +743 -506
- package/dist/api/key_manager/v1alpha1/api.gen.cjs +21 -57
- package/dist/api/key_manager/v1alpha1/api.gen.d.ts +19 -56
- package/dist/api/key_manager/v1alpha1/api.gen.js +21 -57
- package/dist/api/key_manager/v1alpha1/types.gen.d.ts +196 -114
- package/dist/api/marketplace/v2/api.gen.cjs +8 -21
- package/dist/api/marketplace/v2/api.gen.d.ts +10 -24
- package/dist/api/marketplace/v2/api.gen.js +8 -21
- package/dist/api/marketplace/v2/types.gen.d.ts +94 -41
- package/dist/api/mnq/v1beta1/api.gen.cjs +24 -76
- package/dist/api/mnq/v1beta1/api.gen.d.ts +30 -82
- package/dist/api/mnq/v1beta1/api.gen.js +24 -76
- package/dist/api/mnq/v1beta1/types.gen.d.ts +342 -169
- package/dist/api/mongodb/v1alpha1/api.gen.cjs +19 -62
- package/dist/api/mongodb/v1alpha1/api.gen.d.ts +21 -64
- package/dist/api/mongodb/v1alpha1/api.gen.js +19 -62
- package/dist/api/mongodb/v1alpha1/types.gen.d.ts +443 -189
- package/dist/api/qaas/v1alpha1/api.gen.cjs +17 -34
- package/dist/api/qaas/v1alpha1/api.gen.d.ts +19 -36
- package/dist/api/qaas/v1alpha1/api.gen.js +17 -34
- package/dist/api/qaas/v1alpha1/types.gen.d.ts +502 -174
- package/dist/api/rdb/v1/api.gen.cjs +62 -202
- package/dist/api/rdb/v1/api.gen.d.ts +60 -201
- package/dist/api/rdb/v1/api.gen.js +62 -202
- package/dist/api/rdb/v1/types.gen.d.ts +1005 -524
- package/dist/api/redis/v1/api.gen.cjs +23 -83
- package/dist/api/redis/v1/api.gen.d.ts +25 -85
- package/dist/api/redis/v1/api.gen.js +23 -83
- package/dist/api/redis/v1/types.gen.d.ts +447 -170
- package/dist/api/registry/v1/api.gen.cjs +12 -40
- package/dist/api/registry/v1/api.gen.d.ts +14 -42
- package/dist/api/registry/v1/api.gen.js +12 -40
- package/dist/api/registry/v1/types.gen.d.ts +200 -116
- package/dist/api/secret/v1beta1/api.gen.cjs +19 -47
- package/dist/api/secret/v1beta1/api.gen.d.ts +21 -51
- package/dist/api/secret/v1beta1/api.gen.js +19 -47
- package/dist/api/secret/v1beta1/types.gen.d.ts +359 -224
- package/dist/api/serverless_sqldb/v1alpha1/api.gen.cjs +9 -27
- package/dist/api/serverless_sqldb/v1alpha1/api.gen.d.ts +11 -29
- package/dist/api/serverless_sqldb/v1alpha1/api.gen.js +9 -27
- package/dist/api/serverless_sqldb/v1alpha1/types.gen.d.ts +168 -76
- package/dist/api/tem/v1alpha1/api.gen.cjs +22 -58
- package/dist/api/tem/v1alpha1/api.gen.d.ts +24 -60
- package/dist/api/tem/v1alpha1/api.gen.js +22 -58
- package/dist/api/tem/v1alpha1/types.gen.d.ts +761 -338
- package/dist/api/test/v1/api.gen.cjs +8 -11
- package/dist/api/test/v1/api.gen.d.ts +6 -9
- package/dist/api/test/v1/api.gen.js +8 -11
- package/dist/api/test/v1/types.gen.d.ts +21 -10
- package/dist/client/dist/package.json.cjs +1 -1
- package/dist/client/dist/package.json.js +1 -1
- package/node_modules/@scaleway/sdk-client/dist/package.json.cjs +1 -1
- package/node_modules/@scaleway/sdk-client/dist/package.json.js +1 -1
- package/node_modules/@scaleway/sdk-client/package.json +1 -2
- package/package.json +2 -2
- package/node_modules/@scaleway/sdk-client/LICENSE +0 -191
|
@@ -35,8 +35,7 @@ class API extends api.API {
|
|
|
35
35
|
marshalling_gen.unmarshalListDatabaseEnginesResponse
|
|
36
36
|
);
|
|
37
37
|
/**
|
|
38
|
-
* List available database engines. List the PostgreSQL and MySQL database
|
|
39
|
-
* engines available at Scaleway.
|
|
38
|
+
* List available database engines. List the PostgreSQL and MySQL database engines available at Scaleway.
|
|
40
39
|
*
|
|
41
40
|
* @param request - The request {@link ListDatabaseEnginesRequest}
|
|
42
41
|
* @returns A Promise of ListDatabaseEnginesResponse
|
|
@@ -58,9 +57,7 @@ class API extends api.API {
|
|
|
58
57
|
marshalling_gen.unmarshalListNodeTypesResponse
|
|
59
58
|
);
|
|
60
59
|
/**
|
|
61
|
-
* List available node types. List all available node types. By default, the
|
|
62
|
-
* node types returned in the list are ordered by creation date in ascending
|
|
63
|
-
* order, though this can be modified via the `order_by` field.
|
|
60
|
+
* List available node types. List all available node types. By default, the node types returned in the list are ordered by creation date in ascending order, though this can be modified via the `order_by` field.
|
|
64
61
|
*
|
|
65
62
|
* @param request - The request {@link ListNodeTypesRequest}
|
|
66
63
|
* @returns A Promise of ListNodeTypesResponse
|
|
@@ -86,10 +83,7 @@ class API extends api.API {
|
|
|
86
83
|
marshalling_gen.unmarshalListDatabaseBackupsResponse
|
|
87
84
|
);
|
|
88
85
|
/**
|
|
89
|
-
* List database backups. List all backups in a specified region, for a given
|
|
90
|
-
* Scaleway Organization or Scaleway Project. By default, the backups listed
|
|
91
|
-
* are ordered by creation date in ascending order. This can be modified via
|
|
92
|
-
* the `order_by` field.
|
|
86
|
+
* List database backups. List all backups in a specified region, for a given Scaleway Organization or Scaleway Project. By default, the backups listed are ordered by creation date in ascending order. This can be modified via the `order_by` field.
|
|
93
87
|
*
|
|
94
88
|
* @param request - The request {@link ListDatabaseBackupsRequest}
|
|
95
89
|
* @returns A Promise of ListDatabaseBackupsResponse
|
|
@@ -100,8 +94,7 @@ class API extends api.API {
|
|
|
100
94
|
request
|
|
101
95
|
);
|
|
102
96
|
/**
|
|
103
|
-
* Create a database backup. Create a new backup. You must set the
|
|
104
|
-
* `instance_id`, `database_name`, `name` and `expires_at` parameters.
|
|
97
|
+
* Create a database backup. Create a new backup. You must set the `instance_id`, `database_name`, `name` and `expires_at` parameters.
|
|
105
98
|
*
|
|
106
99
|
* @param request - The request {@link CreateDatabaseBackupRequest}
|
|
107
100
|
* @returns A Promise of DatabaseBackup
|
|
@@ -118,9 +111,7 @@ class API extends api.API {
|
|
|
118
111
|
marshalling_gen.unmarshalDatabaseBackup
|
|
119
112
|
);
|
|
120
113
|
/**
|
|
121
|
-
* Get a database backup. Retrieve information about a given backup, specified
|
|
122
|
-
* by its database backup ID and region. Full details about the backup, like
|
|
123
|
-
* size, URL and expiration date, are returned in the response.
|
|
114
|
+
* Get a database backup. Retrieve information about a given backup, specified by its database backup ID and region. Full details about the backup, like size, URL and expiration date, are returned in the response.
|
|
124
115
|
*
|
|
125
116
|
* @param request - The request {@link GetDatabaseBackupRequest}
|
|
126
117
|
* @returns A Promise of DatabaseBackup
|
|
@@ -148,8 +139,7 @@ class API extends api.API {
|
|
|
148
139
|
options
|
|
149
140
|
);
|
|
150
141
|
/**
|
|
151
|
-
* Update a database backup. Update the parameters of a backup, including name
|
|
152
|
-
* and expiration date.
|
|
142
|
+
* Update a database backup. Update the parameters of a backup, including name and expiration date.
|
|
153
143
|
*
|
|
154
144
|
* @param request - The request {@link UpdateDatabaseBackupRequest}
|
|
155
145
|
* @returns A Promise of DatabaseBackup
|
|
@@ -166,8 +156,7 @@ class API extends api.API {
|
|
|
166
156
|
marshalling_gen.unmarshalDatabaseBackup
|
|
167
157
|
);
|
|
168
158
|
/**
|
|
169
|
-
* Delete a database backup. Delete a backup, specified by its database backup
|
|
170
|
-
* ID and region. Deleting a backup is permanent, and cannot be undone.
|
|
159
|
+
* Delete a database backup. Delete a backup, specified by its database backup ID and region. Deleting a backup is permanent, and cannot be undone.
|
|
171
160
|
*
|
|
172
161
|
* @param request - The request {@link DeleteDatabaseBackupRequest}
|
|
173
162
|
* @returns A Promise of DatabaseBackup
|
|
@@ -180,10 +169,7 @@ class API extends api.API {
|
|
|
180
169
|
marshalling_gen.unmarshalDatabaseBackup
|
|
181
170
|
);
|
|
182
171
|
/**
|
|
183
|
-
* Restore a database backup. Launch the process of restoring database backup.
|
|
184
|
-
* You must specify the `instance_id` of the Database Instance of destination,
|
|
185
|
-
* where the backup will be restored. Note that large database backups can
|
|
186
|
-
* take up to several hours to restore.
|
|
172
|
+
* Restore a database backup. Launch the process of restoring database backup. You must specify the `instance_id` of the Database Instance of destination, where the backup will be restored. Note that large database backups can take up to several hours to restore.
|
|
187
173
|
*
|
|
188
174
|
* @param request - The request {@link RestoreDatabaseBackupRequest}
|
|
189
175
|
* @returns A Promise of DatabaseBackup
|
|
@@ -200,9 +186,7 @@ class API extends api.API {
|
|
|
200
186
|
marshalling_gen.unmarshalDatabaseBackup
|
|
201
187
|
);
|
|
202
188
|
/**
|
|
203
|
-
* Export a database backup. Export a backup, specified by the
|
|
204
|
-
* `database_backup_id` and the `region` parameters. The download URL is
|
|
205
|
-
* returned in the response.
|
|
189
|
+
* Export a database backup. Export a backup, specified by the `database_backup_id` and the `region` parameters. The download URL is returned in the response.
|
|
206
190
|
*
|
|
207
191
|
* @param request - The request {@link ExportDatabaseBackupRequest}
|
|
208
192
|
* @returns A Promise of DatabaseBackup
|
|
@@ -217,10 +201,7 @@ class API extends api.API {
|
|
|
217
201
|
marshalling_gen.unmarshalDatabaseBackup
|
|
218
202
|
);
|
|
219
203
|
/**
|
|
220
|
-
* Upgrade a Database Instance. Upgrade your current Database Instance
|
|
221
|
-
* specifications like node type, high availability, volume, or the database
|
|
222
|
-
* engine version. Note that upon upgrade the `enable_ha` parameter can only
|
|
223
|
-
* be set to `true`.
|
|
204
|
+
* Upgrade a Database Instance. Upgrade your current Database Instance specifications like node type, high availability, volume, or the database engine version. Note that upon upgrade the `enable_ha` parameter can only be set to `true`.
|
|
224
205
|
*
|
|
225
206
|
* @param request - The request {@link UpgradeInstanceRequest}
|
|
226
207
|
* @returns A Promise of Instance
|
|
@@ -256,24 +237,14 @@ class API extends api.API {
|
|
|
256
237
|
marshalling_gen.unmarshalListInstancesResponse
|
|
257
238
|
);
|
|
258
239
|
/**
|
|
259
|
-
* List Database Instances. List all Database Instances in the specified
|
|
260
|
-
* region, for a given Scaleway Organization or Scaleway Project. By default,
|
|
261
|
-
* the Database Instances returned in the list are ordered by creation date in
|
|
262
|
-
* ascending order, though this can be modified via the order_by field. You
|
|
263
|
-
* can define additional parameters for your query, such as `tags` and `name`.
|
|
264
|
-
* For the `name` parameter, the value you include will be checked against the
|
|
265
|
-
* whole name string to see if it includes the string you put in the
|
|
266
|
-
* parameter.
|
|
240
|
+
* List Database Instances. List all Database Instances in the specified region, for a given Scaleway Organization or Scaleway Project. By default, the Database Instances returned in the list are ordered by creation date in ascending order, though this can be modified via the order_by field. You can define additional parameters for your query, such as `tags` and `name`. For the `name` parameter, the value you include will be checked against the whole name string to see if it includes the string you put in the parameter.
|
|
267
241
|
*
|
|
268
242
|
* @param request - The request {@link ListInstancesRequest}
|
|
269
243
|
* @returns A Promise of ListInstancesResponse
|
|
270
244
|
*/
|
|
271
245
|
listInstances = (request = {}) => resourcePaginator.enrichForPagination("instances", this.pageOfListInstances, request);
|
|
272
246
|
/**
|
|
273
|
-
* Get a Database Instance. Retrieve information about a given Database
|
|
274
|
-
* Instance, specified by the `region` and `instance_id` parameters. Its full
|
|
275
|
-
* details, including name, status, IP address and port, are returned in the
|
|
276
|
-
* response object.
|
|
247
|
+
* Get a Database Instance. Retrieve information about a given Database Instance, specified by the `region` and `instance_id` parameters. Its full details, including name, status, IP address and port, are returned in the response object.
|
|
277
248
|
*
|
|
278
249
|
* @param request - The request {@link GetInstanceRequest}
|
|
279
250
|
* @returns A Promise of Instance
|
|
@@ -301,9 +272,7 @@ class API extends api.API {
|
|
|
301
272
|
options
|
|
302
273
|
);
|
|
303
274
|
/**
|
|
304
|
-
* Create a Database Instance. Create a new Database Instance. You must set
|
|
305
|
-
* the `engine`, `user_name`, `password` and `node_type` parameters.
|
|
306
|
-
* Optionally, you can specify the volume type and size.
|
|
275
|
+
* Create a Database Instance. Create a new Database Instance. You must set the `engine`, `user_name`, `password` and `node_type` parameters. Optionally, you can specify the volume type and size.
|
|
307
276
|
*
|
|
308
277
|
* @param request - The request {@link CreateInstanceRequest}
|
|
309
278
|
* @returns A Promise of Instance
|
|
@@ -320,8 +289,7 @@ class API extends api.API {
|
|
|
320
289
|
marshalling_gen.unmarshalInstance
|
|
321
290
|
);
|
|
322
291
|
/**
|
|
323
|
-
* Update a Database Instance. Update the parameters of a Database Instance,
|
|
324
|
-
* including name, tags and backup schedule details.
|
|
292
|
+
* Update a Database Instance. Update the parameters of a Database Instance, including name, tags and backup schedule details.
|
|
325
293
|
*
|
|
326
294
|
* @param request - The request {@link UpdateInstanceRequest}
|
|
327
295
|
* @returns A Promise of Instance
|
|
@@ -338,10 +306,7 @@ class API extends api.API {
|
|
|
338
306
|
marshalling_gen.unmarshalInstance
|
|
339
307
|
);
|
|
340
308
|
/**
|
|
341
|
-
* Delete a Database Instance. Delete a given Database Instance, specified by
|
|
342
|
-
* the `region` and `instance_id` parameters. Deleting a Database Instance is
|
|
343
|
-
* permanent, and cannot be undone. Note that upon deletion all your data will
|
|
344
|
-
* be lost.
|
|
309
|
+
* Delete a Database Instance. Delete a given Database Instance, specified by the `region` and `instance_id` parameters. Deleting a Database Instance is permanent, and cannot be undone. Note that upon deletion all your data will be lost.
|
|
345
310
|
*
|
|
346
311
|
* @param request - The request {@link DeleteInstanceRequest}
|
|
347
312
|
* @returns A Promise of Instance
|
|
@@ -354,11 +319,7 @@ class API extends api.API {
|
|
|
354
319
|
marshalling_gen.unmarshalInstance
|
|
355
320
|
);
|
|
356
321
|
/**
|
|
357
|
-
* Clone a Database Instance. Clone a given Database Instance, specified by
|
|
358
|
-
* the `region` and `instance_id` parameters. The clone feature allows you to
|
|
359
|
-
* create a new Database Instance from an existing one. The clone includes all
|
|
360
|
-
* existing databases, users and permissions. You can create a clone on a
|
|
361
|
-
* Database Instance bigger than your current one.
|
|
322
|
+
* Clone a Database Instance. Clone a given Database Instance, specified by the `region` and `instance_id` parameters. The clone feature allows you to create a new Database Instance from an existing one. The clone includes all existing databases, users and permissions. You can create a clone on a Database Instance bigger than your current one.
|
|
362
323
|
*
|
|
363
324
|
* @param request - The request {@link CloneInstanceRequest}
|
|
364
325
|
* @returns A Promise of Instance
|
|
@@ -375,9 +336,7 @@ class API extends api.API {
|
|
|
375
336
|
marshalling_gen.unmarshalInstance
|
|
376
337
|
);
|
|
377
338
|
/**
|
|
378
|
-
* Restart Database Instance. Restart a given Database Instance, specified by
|
|
379
|
-
* the `region` and `instance_id` parameters. The status of the Database
|
|
380
|
-
* Instance returned in the response.
|
|
339
|
+
* Restart Database Instance. Restart a given Database Instance, specified by the `region` and `instance_id` parameters. The status of the Database Instance returned in the response.
|
|
381
340
|
*
|
|
382
341
|
* @param request - The request {@link RestartInstanceRequest}
|
|
383
342
|
* @returns A Promise of Instance
|
|
@@ -392,9 +351,7 @@ class API extends api.API {
|
|
|
392
351
|
marshalling_gen.unmarshalInstance
|
|
393
352
|
);
|
|
394
353
|
/**
|
|
395
|
-
* Get the TLS certificate of a Database Instance. Retrieve information about
|
|
396
|
-
* the TLS certificate of a given Database Instance. Details like name and
|
|
397
|
-
* content are returned in the response.
|
|
354
|
+
* Get the TLS certificate of a Database Instance. Retrieve information about the TLS certificate of a given Database Instance. Details like name and content are returned in the response.
|
|
398
355
|
*
|
|
399
356
|
* @param request - The request {@link GetInstanceCertificateRequest}
|
|
400
357
|
* @returns A Promise of Blob
|
|
@@ -406,11 +363,7 @@ class API extends api.API {
|
|
|
406
363
|
responseType: "blob"
|
|
407
364
|
});
|
|
408
365
|
/**
|
|
409
|
-
* Renew the TLS certificate of a Database Instance. Renew a TLS for a
|
|
410
|
-
* Database Instance. Renewing a certificate means that you will not be able
|
|
411
|
-
* to connect to your Database Instance using the previous certificate. You
|
|
412
|
-
* will also need to download and update the new certificate for all database
|
|
413
|
-
* clients.
|
|
366
|
+
* Renew the TLS certificate of a Database Instance. Renew a TLS for a Database Instance. Renewing a certificate means that you will not be able to connect to your Database Instance using the previous certificate. You will also need to download and update the new certificate for all database clients.
|
|
414
367
|
*
|
|
415
368
|
* @param request - The request {@link RenewInstanceCertificateRequest}
|
|
416
369
|
*/
|
|
@@ -421,9 +374,7 @@ class API extends api.API {
|
|
|
421
374
|
path: `/rdb/v1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/instances/${marshalling.validatePathParam("instanceId", request.instanceId)}/renew-certificate`
|
|
422
375
|
});
|
|
423
376
|
/**
|
|
424
|
-
* Get Database Instance metrics. Retrieve the time series metrics of a given
|
|
425
|
-
* Database Instance. You can define the period from which to retrieve metrics
|
|
426
|
-
* by specifying the `start_date` and `end_date`.
|
|
377
|
+
* Get Database Instance metrics. Retrieve the time series metrics of a given Database Instance. You can define the period from which to retrieve metrics by specifying the `start_date` and `end_date`.
|
|
427
378
|
*
|
|
428
379
|
* @param request - The request {@link GetInstanceMetricsRequest}
|
|
429
380
|
* @returns A Promise of InstanceMetrics
|
|
@@ -441,9 +392,7 @@ class API extends api.API {
|
|
|
441
392
|
marshalling_gen.unmarshalInstanceMetrics
|
|
442
393
|
);
|
|
443
394
|
/**
|
|
444
|
-
* Create a Read Replica. Create a new Read Replica of a Database Instance.
|
|
445
|
-
* You must specify the `region` and the `instance_id`. You can only create a
|
|
446
|
-
* maximum of 3 Read Replicas per Database Instance.
|
|
395
|
+
* Create a Read Replica. Create a new Read Replica of a Database Instance. You must specify the `region` and the `instance_id`. You can only create a maximum of 3 Read Replicas per Database Instance.
|
|
447
396
|
*
|
|
448
397
|
* @param request - The request {@link CreateReadReplicaRequest}
|
|
449
398
|
* @returns A Promise of ReadReplica
|
|
@@ -460,9 +409,7 @@ class API extends api.API {
|
|
|
460
409
|
marshalling_gen.unmarshalReadReplica
|
|
461
410
|
);
|
|
462
411
|
/**
|
|
463
|
-
* Get a Read Replica. Retrieve information about a Database Instance Read
|
|
464
|
-
* Replica. Full details about the Read Replica, like `endpoints`, `status`
|
|
465
|
-
* and `region` are returned in the response.
|
|
412
|
+
* Get a Read Replica. Retrieve information about a Database Instance Read Replica. Full details about the Read Replica, like `endpoints`, `status` and `region` are returned in the response.
|
|
466
413
|
*
|
|
467
414
|
* @param request - The request {@link GetReadReplicaRequest}
|
|
468
415
|
* @returns A Promise of ReadReplica
|
|
@@ -490,9 +437,7 @@ class API extends api.API {
|
|
|
490
437
|
options
|
|
491
438
|
);
|
|
492
439
|
/**
|
|
493
|
-
* Delete a Read Replica. Delete a Read Replica of a Database Instance. You
|
|
494
|
-
* must specify the `region` and `read_replica_id` parameters of the Read
|
|
495
|
-
* Replica you want to delete.
|
|
440
|
+
* Delete a Read Replica. Delete a Read Replica of a Database Instance. You must specify the `region` and `read_replica_id` parameters of the Read Replica you want to delete.
|
|
496
441
|
*
|
|
497
442
|
* @param request - The request {@link DeleteReadReplicaRequest}
|
|
498
443
|
* @returns A Promise of ReadReplica
|
|
@@ -505,15 +450,12 @@ class API extends api.API {
|
|
|
505
450
|
marshalling_gen.unmarshalReadReplica
|
|
506
451
|
);
|
|
507
452
|
/**
|
|
508
|
-
|
|
509
|
-
|
|
510
|
-
|
|
511
|
-
|
|
512
|
-
|
|
513
|
-
|
|
514
|
-
* @param request - The request {@link ResetReadReplicaRequest}
|
|
515
|
-
* @returns A Promise of ReadReplica
|
|
516
|
-
*/
|
|
453
|
+
* Resync a Read Replica. When you resync a Read Replica, first it is reset, then its data is resynchronized from the primary node. Your Read Replica remains unavailable during the resync process. The duration of this process is proportional to the size of your Database Instance.
|
|
454
|
+
The configured endpoints do not change.
|
|
455
|
+
*
|
|
456
|
+
* @param request - The request {@link ResetReadReplicaRequest}
|
|
457
|
+
* @returns A Promise of ReadReplica
|
|
458
|
+
*/
|
|
517
459
|
resetReadReplica = (request) => this.client.fetch(
|
|
518
460
|
{
|
|
519
461
|
body: "{}",
|
|
@@ -524,8 +466,7 @@ class API extends api.API {
|
|
|
524
466
|
marshalling_gen.unmarshalReadReplica
|
|
525
467
|
);
|
|
526
468
|
/**
|
|
527
|
-
* Promote a Read Replica. Promote a Read Replica to Database Instance
|
|
528
|
-
* automatically.
|
|
469
|
+
* Promote a Read Replica. Promote a Read Replica to Database Instance automatically.
|
|
529
470
|
*
|
|
530
471
|
* @param request - The request {@link PromoteReadReplicaRequest}
|
|
531
472
|
* @returns A Promise of Instance
|
|
@@ -540,9 +481,7 @@ class API extends api.API {
|
|
|
540
481
|
marshalling_gen.unmarshalInstance
|
|
541
482
|
);
|
|
542
483
|
/**
|
|
543
|
-
* Create an endpoint for a Read Replica. Create a new endpoint for a Read
|
|
544
|
-
* Replica. Read Replicas can have at most one direct access and one Private
|
|
545
|
-
* Network endpoint.
|
|
484
|
+
* Create an endpoint for a Read Replica. Create a new endpoint for a Read Replica. Read Replicas can have at most one direct access and one Private Network endpoint.
|
|
546
485
|
*
|
|
547
486
|
* @param request - The request {@link CreateReadReplicaEndpointRequest}
|
|
548
487
|
* @returns A Promise of ReadReplica
|
|
@@ -562,12 +501,7 @@ class API extends api.API {
|
|
|
562
501
|
marshalling_gen.unmarshalReadReplica
|
|
563
502
|
);
|
|
564
503
|
/**
|
|
565
|
-
* Prepare logs of a Database Instance. Prepare your Database Instance logs.
|
|
566
|
-
* You can define the `start_date` and `end_date` parameters for your query.
|
|
567
|
-
* The download URL is returned in the response. Logs are recorded from 00h00
|
|
568
|
-
* to 23h59 and then aggregated in a `.log` file once a day. Therefore, even
|
|
569
|
-
* if you specify a timeframe from which you want to get the logs, you will
|
|
570
|
-
* receive logs from the full 24 hours.
|
|
504
|
+
* Prepare logs of a Database Instance. Prepare your Database Instance logs. You can define the `start_date` and `end_date` parameters for your query. The download URL is returned in the response. Logs are recorded from 00h00 to 23h59 and then aggregated in a `.log` file once a day. Therefore, even if you specify a timeframe from which you want to get the logs, you will receive logs from the full 24 hours.
|
|
571
505
|
*
|
|
572
506
|
* @param request - The request {@link PrepareInstanceLogsRequest}
|
|
573
507
|
* @returns A Promise of PrepareInstanceLogsResponse
|
|
@@ -584,10 +518,7 @@ class API extends api.API {
|
|
|
584
518
|
marshalling_gen.unmarshalPrepareInstanceLogsResponse
|
|
585
519
|
);
|
|
586
520
|
/**
|
|
587
|
-
* List available logs of a Database Instance. List the available logs of a
|
|
588
|
-
* Database Instance. By default, the logs returned in the list are ordered by
|
|
589
|
-
* creation date in ascending order, though this can be modified via the
|
|
590
|
-
* order_by field.
|
|
521
|
+
* List available logs of a Database Instance. List the available logs of a Database Instance. By default, the logs returned in the list are ordered by creation date in ascending order, though this can be modified via the order_by field.
|
|
591
522
|
*
|
|
592
523
|
* @param request - The request {@link ListInstanceLogsRequest}
|
|
593
524
|
* @returns A Promise of ListInstanceLogsResponse
|
|
@@ -601,10 +532,7 @@ class API extends api.API {
|
|
|
601
532
|
marshalling_gen.unmarshalListInstanceLogsResponse
|
|
602
533
|
);
|
|
603
534
|
/**
|
|
604
|
-
* Get given logs of a Database Instance. Retrieve information about the logs
|
|
605
|
-
* of a Database Instance. Specify the `instance_log_id` and `region` in your
|
|
606
|
-
* request to get information such as `download_url`, `status`, `expires_at`
|
|
607
|
-
* and `created_at` about your logs in the response.
|
|
535
|
+
* Get given logs of a Database Instance. Retrieve information about the logs of a Database Instance. Specify the `instance_log_id` and `region` in your request to get information such as `download_url`, `status`, `expires_at` and `created_at` about your logs in the response.
|
|
608
536
|
*
|
|
609
537
|
* @param request - The request {@link GetInstanceLogRequest}
|
|
610
538
|
* @returns A Promise of InstanceLog
|
|
@@ -632,9 +560,7 @@ class API extends api.API {
|
|
|
632
560
|
options
|
|
633
561
|
);
|
|
634
562
|
/**
|
|
635
|
-
* Purge remote Database Instance logs. Purge a given remote log from a
|
|
636
|
-
* Database Instance. You can specify the `log_name` of the log you wish to
|
|
637
|
-
* clean from your Database Instance.
|
|
563
|
+
* Purge remote Database Instance logs. Purge a given remote log from a Database Instance. You can specify the `log_name` of the log you wish to clean from your Database Instance.
|
|
638
564
|
*
|
|
639
565
|
* @param request - The request {@link PurgeInstanceLogsRequest}
|
|
640
566
|
*/
|
|
@@ -647,9 +573,7 @@ class API extends api.API {
|
|
|
647
573
|
path: `/rdb/v1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/instances/${marshalling.validatePathParam("instanceId", request.instanceId)}/purge-logs`
|
|
648
574
|
});
|
|
649
575
|
/**
|
|
650
|
-
* List remote Database Instance logs details. List remote log details. By
|
|
651
|
-
* default, the details returned in the list are ordered by creation date in
|
|
652
|
-
* ascending order, though this can be modified via the order_by field.
|
|
576
|
+
* List remote Database Instance logs details. List remote log details. By default, the details returned in the list are ordered by creation date in ascending order, though this can be modified via the order_by field.
|
|
653
577
|
*
|
|
654
578
|
* @param request - The request {@link ListInstanceLogsDetailsRequest}
|
|
655
579
|
* @returns A Promise of ListInstanceLogsDetailsResponse
|
|
@@ -662,9 +586,7 @@ class API extends api.API {
|
|
|
662
586
|
marshalling_gen.unmarshalListInstanceLogsDetailsResponse
|
|
663
587
|
);
|
|
664
588
|
/**
|
|
665
|
-
* Add Database Instance advanced settings. Add an advanced setting to a
|
|
666
|
-
* Database Instance. You must set the `name` and the `value` of each
|
|
667
|
-
* setting.
|
|
589
|
+
* Add Database Instance advanced settings. Add an advanced setting to a Database Instance. You must set the `name` and the `value` of each setting.
|
|
668
590
|
*
|
|
669
591
|
* @param request - The request {@link AddInstanceSettingsRequest}
|
|
670
592
|
* @returns A Promise of AddInstanceSettingsResponse
|
|
@@ -681,9 +603,7 @@ class API extends api.API {
|
|
|
681
603
|
marshalling_gen.unmarshalAddInstanceSettingsResponse
|
|
682
604
|
);
|
|
683
605
|
/**
|
|
684
|
-
* Delete Database Instance advanced settings. Delete an advanced setting in a
|
|
685
|
-
* Database Instance. You must specify the names of the settings you want to
|
|
686
|
-
* delete in the request.
|
|
606
|
+
* Delete Database Instance advanced settings. Delete an advanced setting in a Database Instance. You must specify the names of the settings you want to delete in the request.
|
|
687
607
|
*
|
|
688
608
|
* @param request - The request {@link DeleteInstanceSettingsRequest}
|
|
689
609
|
* @returns A Promise of DeleteInstanceSettingsResponse
|
|
@@ -700,9 +620,7 @@ class API extends api.API {
|
|
|
700
620
|
marshalling_gen.unmarshalDeleteInstanceSettingsResponse
|
|
701
621
|
);
|
|
702
622
|
/**
|
|
703
|
-
* Set Database Instance advanced settings. Update an advanced setting for a
|
|
704
|
-
* Database Instance. Settings added upon database engine initalization can
|
|
705
|
-
* only be defined once, and cannot, therefore, be updated.
|
|
623
|
+
* Set Database Instance advanced settings. Update an advanced setting for a Database Instance. Settings added upon database engine initalization can only be defined once, and cannot, therefore, be updated.
|
|
706
624
|
*
|
|
707
625
|
* @param request - The request {@link SetInstanceSettingsRequest}
|
|
708
626
|
* @returns A Promise of SetInstanceSettingsResponse
|
|
@@ -733,18 +651,14 @@ class API extends api.API {
|
|
|
733
651
|
marshalling_gen.unmarshalListInstanceACLRulesResponse
|
|
734
652
|
);
|
|
735
653
|
/**
|
|
736
|
-
* List ACL rules of a Database Instance. List the ACL rules for a given
|
|
737
|
-
* Database Instance. The response is an array of ACL objects, each one
|
|
738
|
-
* representing an ACL that denies, allows or redirects traffic based on
|
|
739
|
-
* certain conditions.
|
|
654
|
+
* List ACL rules of a Database Instance. List the ACL rules for a given Database Instance. The response is an array of ACL objects, each one representing an ACL that denies, allows or redirects traffic based on certain conditions.
|
|
740
655
|
*
|
|
741
656
|
* @param request - The request {@link ListInstanceACLRulesRequest}
|
|
742
657
|
* @returns A Promise of ListInstanceACLRulesResponse
|
|
743
658
|
*/
|
|
744
659
|
listInstanceACLRules = (request) => resourcePaginator.enrichForPagination("rules", this.pageOfListInstanceACLRules, request);
|
|
745
660
|
/**
|
|
746
|
-
* Add an ACL rule to a Database Instance. Add an additional ACL rule to a
|
|
747
|
-
* Database Instance.
|
|
661
|
+
* Add an ACL rule to a Database Instance. Add an additional ACL rule to a Database Instance.
|
|
748
662
|
*
|
|
749
663
|
* @param request - The request {@link AddInstanceACLRulesRequest}
|
|
750
664
|
* @returns A Promise of AddInstanceACLRulesResponse
|
|
@@ -761,8 +675,7 @@ class API extends api.API {
|
|
|
761
675
|
marshalling_gen.unmarshalAddInstanceACLRulesResponse
|
|
762
676
|
);
|
|
763
677
|
/**
|
|
764
|
-
* Set ACL rules for a Database Instance. Replace all the ACL rules of a
|
|
765
|
-
* Database Instance.
|
|
678
|
+
* Set ACL rules for a Database Instance. Replace all the ACL rules of a Database Instance.
|
|
766
679
|
*
|
|
767
680
|
* @param request - The request {@link SetInstanceACLRulesRequest}
|
|
768
681
|
* @returns A Promise of SetInstanceACLRulesResponse
|
|
@@ -779,8 +692,7 @@ class API extends api.API {
|
|
|
779
692
|
marshalling_gen.unmarshalSetInstanceACLRulesResponse
|
|
780
693
|
);
|
|
781
694
|
/**
|
|
782
|
-
* Delete ACL rules of a Database Instance. Delete one or more ACL rules of a
|
|
783
|
-
* Database Instance.
|
|
695
|
+
* Delete ACL rules of a Database Instance. Delete one or more ACL rules of a Database Instance.
|
|
784
696
|
*
|
|
785
697
|
* @param request - The request {@link DeleteInstanceACLRulesRequest}
|
|
786
698
|
* @returns A Promise of DeleteInstanceACLRulesResponse
|
|
@@ -813,19 +725,14 @@ class API extends api.API {
|
|
|
813
725
|
marshalling_gen.unmarshalListUsersResponse
|
|
814
726
|
);
|
|
815
727
|
/**
|
|
816
|
-
* List users of a Database Instance. List all users of a given Database
|
|
817
|
-
* Instance. By default, the users returned in the list are ordered by
|
|
818
|
-
* creation date in ascending order, though this can be modified via the
|
|
819
|
-
* order_by field.
|
|
728
|
+
* List users of a Database Instance. List all users of a given Database Instance. By default, the users returned in the list are ordered by creation date in ascending order, though this can be modified via the order_by field.
|
|
820
729
|
*
|
|
821
730
|
* @param request - The request {@link ListUsersRequest}
|
|
822
731
|
* @returns A Promise of ListUsersResponse
|
|
823
732
|
*/
|
|
824
733
|
listUsers = (request) => resourcePaginator.enrichForPagination("users", this.pageOfListUsers, request);
|
|
825
734
|
/**
|
|
826
|
-
* Create a user for a Database Instance. Create a new user for a Database
|
|
827
|
-
* Instance. You must define the `name`, `password` and `is_admin`
|
|
828
|
-
* parameters.
|
|
735
|
+
* Create a user for a Database Instance. Create a new user for a Database Instance. You must define the `name`, `password` and `is_admin` parameters.
|
|
829
736
|
*
|
|
830
737
|
* @param request - The request {@link CreateUserRequest}
|
|
831
738
|
* @returns A Promise of User
|
|
@@ -842,9 +749,7 @@ class API extends api.API {
|
|
|
842
749
|
marshalling_gen.unmarshalUser
|
|
843
750
|
);
|
|
844
751
|
/**
|
|
845
|
-
* Update a user on a Database Instance. Update the parameters of a user on a
|
|
846
|
-
* Database Instance. You can update the `password` and `is_admin` parameters,
|
|
847
|
-
* but you cannot change the name of the user.
|
|
752
|
+
* Update a user on a Database Instance. Update the parameters of a user on a Database Instance. You can update the `password` and `is_admin` parameters, but you cannot change the name of the user.
|
|
848
753
|
*
|
|
849
754
|
* @param request - The request {@link UpdateUserRequest}
|
|
850
755
|
* @returns A Promise of User
|
|
@@ -861,9 +766,7 @@ class API extends api.API {
|
|
|
861
766
|
marshalling_gen.unmarshalUser
|
|
862
767
|
);
|
|
863
768
|
/**
|
|
864
|
-
* Delete a user on a Database Instance. Delete a given user on a Database
|
|
865
|
-
* Instance. You must specify, in the endpoint, the `region`, `instance_id`
|
|
866
|
-
* and `name` parameters of the user you want to delete.
|
|
769
|
+
* Delete a user on a Database Instance. Delete a given user on a Database Instance. You must specify, in the endpoint, the `region`, `instance_id` and `name` parameters of the user you want to delete.
|
|
867
770
|
*
|
|
868
771
|
* @param request - The request {@link DeleteUserRequest}
|
|
869
772
|
*/
|
|
@@ -890,19 +793,14 @@ class API extends api.API {
|
|
|
890
793
|
marshalling_gen.unmarshalListDatabasesResponse
|
|
891
794
|
);
|
|
892
795
|
/**
|
|
893
|
-
* List databases in a Database Instance. List all databases of a given
|
|
894
|
-
* Database Instance. By default, the databases returned in the list are
|
|
895
|
-
* ordered by creation date in ascending order, though this can be modified
|
|
896
|
-
* via the order_by field. You can define additional parameters for your
|
|
897
|
-
* query, such as `name`, `managed` and `owner`.
|
|
796
|
+
* List databases in a Database Instance. List all databases of a given Database Instance. By default, the databases returned in the list are ordered by creation date in ascending order, though this can be modified via the order_by field. You can define additional parameters for your query, such as `name`, `managed` and `owner`.
|
|
898
797
|
*
|
|
899
798
|
* @param request - The request {@link ListDatabasesRequest}
|
|
900
799
|
* @returns A Promise of ListDatabasesResponse
|
|
901
800
|
*/
|
|
902
801
|
listDatabases = (request) => resourcePaginator.enrichForPagination("databases", this.pageOfListDatabases, request);
|
|
903
802
|
/**
|
|
904
|
-
* Create a database in a Database Instance. Create a new database. You must
|
|
905
|
-
* define the `name` parameter in the request.
|
|
803
|
+
* Create a database in a Database Instance. Create a new database. You must define the `name` parameter in the request.
|
|
906
804
|
*
|
|
907
805
|
* @param request - The request {@link CreateDatabaseRequest}
|
|
908
806
|
* @returns A Promise of Database
|
|
@@ -919,9 +817,7 @@ class API extends api.API {
|
|
|
919
817
|
marshalling_gen.unmarshalDatabase
|
|
920
818
|
);
|
|
921
819
|
/**
|
|
922
|
-
* Delete a database in a Database Instance. Delete a given database on a
|
|
923
|
-
* Database Instance. You must specify, in the endpoint, the `region`,
|
|
924
|
-
* `instance_id` and `name` parameters of the database you want to delete.
|
|
820
|
+
* Delete a database in a Database Instance. Delete a given database on a Database Instance. You must specify, in the endpoint, the `region`, `instance_id` and `name` parameters of the database you want to delete.
|
|
925
821
|
*
|
|
926
822
|
* @param request - The request {@link DeleteDatabaseRequest}
|
|
927
823
|
*/
|
|
@@ -947,20 +843,14 @@ class API extends api.API {
|
|
|
947
843
|
marshalling_gen.unmarshalListPrivilegesResponse
|
|
948
844
|
);
|
|
949
845
|
/**
|
|
950
|
-
* List user privileges for a database. List privileges of a user on a
|
|
951
|
-
* database. By default, the details returned in the list are ordered by
|
|
952
|
-
* creation date in ascending order, though this can be modified via the
|
|
953
|
-
* order_by field. You can define additional parameters for your query, such
|
|
954
|
-
* as `database_name` and `user_name`.
|
|
846
|
+
* List user privileges for a database. List privileges of a user on a database. By default, the details returned in the list are ordered by creation date in ascending order, though this can be modified via the order_by field. You can define additional parameters for your query, such as `database_name` and `user_name`.
|
|
955
847
|
*
|
|
956
848
|
* @param request - The request {@link ListPrivilegesRequest}
|
|
957
849
|
* @returns A Promise of ListPrivilegesResponse
|
|
958
850
|
*/
|
|
959
851
|
listPrivileges = (request) => resourcePaginator.enrichForPagination("privileges", this.pageOfListPrivileges, request);
|
|
960
852
|
/**
|
|
961
|
-
* Set user privileges for a database. Set the privileges of a user on a
|
|
962
|
-
* database. You must define `database_name`, `user_name` and `permission` in
|
|
963
|
-
* the request body.
|
|
853
|
+
* Set user privileges for a database. Set the privileges of a user on a database. You must define `database_name`, `user_name` and `permission` in the request body.
|
|
964
854
|
*
|
|
965
855
|
* @param request - The request {@link SetPrivilegeRequest}
|
|
966
856
|
* @returns A Promise of Privilege
|
|
@@ -996,20 +886,14 @@ class API extends api.API {
|
|
|
996
886
|
marshalling_gen.unmarshalListSnapshotsResponse
|
|
997
887
|
);
|
|
998
888
|
/**
|
|
999
|
-
* List snapshots. List snapshots. You can include the `instance_id` or
|
|
1000
|
-
* `project_id` in your query to get the list of snapshots for specific
|
|
1001
|
-
* Database Instances and/or Projects. By default, the details returned in the
|
|
1002
|
-
* list are ordered by creation date in ascending order, though this can be
|
|
1003
|
-
* modified via the `order_by` field.
|
|
889
|
+
* List snapshots. List snapshots. You can include the `instance_id` or `project_id` in your query to get the list of snapshots for specific Database Instances and/or Projects. By default, the details returned in the list are ordered by creation date in ascending order, though this can be modified via the `order_by` field.
|
|
1004
890
|
*
|
|
1005
891
|
* @param request - The request {@link ListSnapshotsRequest}
|
|
1006
892
|
* @returns A Promise of ListSnapshotsResponse
|
|
1007
893
|
*/
|
|
1008
894
|
listSnapshots = (request = {}) => resourcePaginator.enrichForPagination("snapshots", this.pageOfListSnapshots, request);
|
|
1009
895
|
/**
|
|
1010
|
-
* Get a Database Instance snapshot. Retrieve information about a given
|
|
1011
|
-
* snapshot, specified by its `snapshot_id` and `region`. Full details about
|
|
1012
|
-
* the snapshot, like size and expiration date, are returned in the response.
|
|
896
|
+
* Get a Database Instance snapshot. Retrieve information about a given snapshot, specified by its `snapshot_id` and `region`. Full details about the snapshot, like size and expiration date, are returned in the response.
|
|
1013
897
|
*
|
|
1014
898
|
* @param request - The request {@link GetSnapshotRequest}
|
|
1015
899
|
* @returns A Promise of Snapshot
|
|
@@ -1037,8 +921,7 @@ class API extends api.API {
|
|
|
1037
921
|
options
|
|
1038
922
|
);
|
|
1039
923
|
/**
|
|
1040
|
-
* Create a Database Instance snapshot. Create a new snapshot of a Database
|
|
1041
|
-
* Instance. You must define the `name` parameter in the request.
|
|
924
|
+
* Create a Database Instance snapshot. Create a new snapshot of a Database Instance. You must define the `name` parameter in the request.
|
|
1042
925
|
*
|
|
1043
926
|
* @param request - The request {@link CreateSnapshotRequest}
|
|
1044
927
|
* @returns A Promise of Snapshot
|
|
@@ -1055,9 +938,7 @@ class API extends api.API {
|
|
|
1055
938
|
marshalling_gen.unmarshalSnapshot
|
|
1056
939
|
);
|
|
1057
940
|
/**
|
|
1058
|
-
* Update a Database Instance snapshot. Update the parameters of a snapshot of
|
|
1059
|
-
* a Database Instance. You can update the `name` and `expires_at`
|
|
1060
|
-
* parameters.
|
|
941
|
+
* Update a Database Instance snapshot. Update the parameters of a snapshot of a Database Instance. You can update the `name` and `expires_at` parameters.
|
|
1061
942
|
*
|
|
1062
943
|
* @param request - The request {@link UpdateSnapshotRequest}
|
|
1063
944
|
* @returns A Promise of Snapshot
|
|
@@ -1074,9 +955,7 @@ class API extends api.API {
|
|
|
1074
955
|
marshalling_gen.unmarshalSnapshot
|
|
1075
956
|
);
|
|
1076
957
|
/**
|
|
1077
|
-
* Delete a Database Instance snapshot. Delete a given snapshot of a Database
|
|
1078
|
-
* Instance. You must specify, in the endpoint, the `region` and `snapshot_id`
|
|
1079
|
-
* parameters of the snapshot you want to delete.
|
|
958
|
+
* Delete a Database Instance snapshot. Delete a given snapshot of a Database Instance. You must specify, in the endpoint, the `region` and `snapshot_id` parameters of the snapshot you want to delete.
|
|
1080
959
|
*
|
|
1081
960
|
* @param request - The request {@link DeleteSnapshotRequest}
|
|
1082
961
|
* @returns A Promise of Snapshot
|
|
@@ -1089,14 +968,7 @@ class API extends api.API {
|
|
|
1089
968
|
marshalling_gen.unmarshalSnapshot
|
|
1090
969
|
);
|
|
1091
970
|
/**
|
|
1092
|
-
* Create a new Database Instance from a snapshot. Restore a snapshot. When
|
|
1093
|
-
* you restore a snapshot, a new Instance is created and billed to your
|
|
1094
|
-
* account. Note that is possible to select a larger node type for your new
|
|
1095
|
-
* Database Instance. However, the Block volume size will be the same as the
|
|
1096
|
-
* size of the restored snapshot. All Instance settings will be restored if
|
|
1097
|
-
* you chose a node type with the same or more memory size than the initial
|
|
1098
|
-
* Instance. Settings will be reset to the default if your node type has less
|
|
1099
|
-
* memory.
|
|
971
|
+
* Create a new Database Instance from a snapshot. Restore a snapshot. When you restore a snapshot, a new Instance is created and billed to your account. Note that is possible to select a larger node type for your new Database Instance. However, the Block volume size will be the same as the size of the restored snapshot. All Instance settings will be restored if you chose a node type with the same or more memory size than the initial Instance. Settings will be reset to the default if your node type has less memory.
|
|
1100
972
|
*
|
|
1101
973
|
* @param request - The request {@link CreateInstanceFromSnapshotRequest}
|
|
1102
974
|
* @returns A Promise of Instance
|
|
@@ -1116,9 +988,7 @@ class API extends api.API {
|
|
|
1116
988
|
marshalling_gen.unmarshalInstance
|
|
1117
989
|
);
|
|
1118
990
|
/**
|
|
1119
|
-
* Create a new Database Instance endpoint. Create a new endpoint for a
|
|
1120
|
-
* Database Instance. You can add `load_balancer` and `private_network`
|
|
1121
|
-
* specifications to the body of the request.
|
|
991
|
+
* Create a new Database Instance endpoint. Create a new endpoint for a Database Instance. You can add `load_balancer` and `private_network` specifications to the body of the request.
|
|
1122
992
|
*
|
|
1123
993
|
* @param request - The request {@link CreateEndpointRequest}
|
|
1124
994
|
* @returns A Promise of Endpoint
|
|
@@ -1135,10 +1005,7 @@ class API extends api.API {
|
|
|
1135
1005
|
marshalling_gen.unmarshalEndpoint
|
|
1136
1006
|
);
|
|
1137
1007
|
/**
|
|
1138
|
-
* Delete a Database Instance endpoint. Delete the endpoint of a Database
|
|
1139
|
-
* Instance. You must specify the `region` and `endpoint_id` parameters of the
|
|
1140
|
-
* endpoint you want to delete. Note that might need to update any environment
|
|
1141
|
-
* configurations that point to the deleted endpoint.
|
|
1008
|
+
* Delete a Database Instance endpoint. Delete the endpoint of a Database Instance. You must specify the `region` and `endpoint_id` parameters of the endpoint you want to delete. Note that might need to update any environment configurations that point to the deleted endpoint.
|
|
1142
1009
|
*
|
|
1143
1010
|
* @param request - The request {@link DeleteEndpointRequest}
|
|
1144
1011
|
*/
|
|
@@ -1147,10 +1014,7 @@ class API extends api.API {
|
|
|
1147
1014
|
path: `/rdb/v1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/endpoints/${marshalling.validatePathParam("endpointId", request.endpointId)}`
|
|
1148
1015
|
});
|
|
1149
1016
|
/**
|
|
1150
|
-
* Get a Database Instance endpoint. Retrieve information about a Database
|
|
1151
|
-
* Instance endpoint. Full details about the endpoint, like `ip`, `port`,
|
|
1152
|
-
* `private_network` and `load_balancer` specifications are returned in the
|
|
1153
|
-
* response.
|
|
1017
|
+
* Get a Database Instance endpoint. Retrieve information about a Database Instance endpoint. Full details about the endpoint, like `ip`, `port`, `private_network` and `load_balancer` specifications are returned in the response.
|
|
1154
1018
|
*
|
|
1155
1019
|
* @param request - The request {@link GetEndpointRequest}
|
|
1156
1020
|
* @returns A Promise of Endpoint
|
|
@@ -1180,11 +1044,7 @@ class API extends api.API {
|
|
|
1180
1044
|
marshalling_gen.unmarshalEndpoint
|
|
1181
1045
|
);
|
|
1182
1046
|
/**
|
|
1183
|
-
* Apply Database Instance maintenance. Apply maintenance tasks to your
|
|
1184
|
-
* Database Instance. This will trigger pending maintenance tasks to start in
|
|
1185
|
-
* your Database Instance and can generate service interruption. Maintenance
|
|
1186
|
-
* tasks can be applied between `starts_at` and `stops_at` times, and are run
|
|
1187
|
-
* directly by Scaleway at `forced_at` timestamp.
|
|
1047
|
+
* Apply Database Instance maintenance. Apply maintenance tasks to your Database Instance. This will trigger pending maintenance tasks to start in your Database Instance and can generate service interruption. Maintenance tasks can be applied between `starts_at` and `stops_at` times, and are run directly by Scaleway at `forced_at` timestamp.
|
|
1188
1048
|
*
|
|
1189
1049
|
* @param request - The request {@link ApplyInstanceMaintenanceRequest}
|
|
1190
1050
|
* @returns A Promise of Maintenance
|