@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
|
@@ -33,8 +33,7 @@ class API extends API$1 {
|
|
|
33
33
|
unmarshalListDatabaseEnginesResponse
|
|
34
34
|
);
|
|
35
35
|
/**
|
|
36
|
-
* List available database engines. List the PostgreSQL and MySQL database
|
|
37
|
-
* engines available at Scaleway.
|
|
36
|
+
* List available database engines. List the PostgreSQL and MySQL database engines available at Scaleway.
|
|
38
37
|
*
|
|
39
38
|
* @param request - The request {@link ListDatabaseEnginesRequest}
|
|
40
39
|
* @returns A Promise of ListDatabaseEnginesResponse
|
|
@@ -56,9 +55,7 @@ class API extends API$1 {
|
|
|
56
55
|
unmarshalListNodeTypesResponse
|
|
57
56
|
);
|
|
58
57
|
/**
|
|
59
|
-
* List available node types. List all available node types. By default, the
|
|
60
|
-
* node types returned in the list are ordered by creation date in ascending
|
|
61
|
-
* order, though this can be modified via the `order_by` field.
|
|
58
|
+
* 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.
|
|
62
59
|
*
|
|
63
60
|
* @param request - The request {@link ListNodeTypesRequest}
|
|
64
61
|
* @returns A Promise of ListNodeTypesResponse
|
|
@@ -84,10 +81,7 @@ class API extends API$1 {
|
|
|
84
81
|
unmarshalListDatabaseBackupsResponse
|
|
85
82
|
);
|
|
86
83
|
/**
|
|
87
|
-
* List database backups. List all backups in a specified region, for a given
|
|
88
|
-
* Scaleway Organization or Scaleway Project. By default, the backups listed
|
|
89
|
-
* are ordered by creation date in ascending order. This can be modified via
|
|
90
|
-
* the `order_by` field.
|
|
84
|
+
* 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.
|
|
91
85
|
*
|
|
92
86
|
* @param request - The request {@link ListDatabaseBackupsRequest}
|
|
93
87
|
* @returns A Promise of ListDatabaseBackupsResponse
|
|
@@ -98,8 +92,7 @@ class API extends API$1 {
|
|
|
98
92
|
request
|
|
99
93
|
);
|
|
100
94
|
/**
|
|
101
|
-
* Create a database backup. Create a new backup. You must set the
|
|
102
|
-
* `instance_id`, `database_name`, `name` and `expires_at` parameters.
|
|
95
|
+
* Create a database backup. Create a new backup. You must set the `instance_id`, `database_name`, `name` and `expires_at` parameters.
|
|
103
96
|
*
|
|
104
97
|
* @param request - The request {@link CreateDatabaseBackupRequest}
|
|
105
98
|
* @returns A Promise of DatabaseBackup
|
|
@@ -116,9 +109,7 @@ class API extends API$1 {
|
|
|
116
109
|
unmarshalDatabaseBackup
|
|
117
110
|
);
|
|
118
111
|
/**
|
|
119
|
-
* Get a database backup. Retrieve information about a given backup, specified
|
|
120
|
-
* by its database backup ID and region. Full details about the backup, like
|
|
121
|
-
* size, URL and expiration date, are returned in the response.
|
|
112
|
+
* 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.
|
|
122
113
|
*
|
|
123
114
|
* @param request - The request {@link GetDatabaseBackupRequest}
|
|
124
115
|
* @returns A Promise of DatabaseBackup
|
|
@@ -146,8 +137,7 @@ class API extends API$1 {
|
|
|
146
137
|
options
|
|
147
138
|
);
|
|
148
139
|
/**
|
|
149
|
-
* Update a database backup. Update the parameters of a backup, including name
|
|
150
|
-
* and expiration date.
|
|
140
|
+
* Update a database backup. Update the parameters of a backup, including name and expiration date.
|
|
151
141
|
*
|
|
152
142
|
* @param request - The request {@link UpdateDatabaseBackupRequest}
|
|
153
143
|
* @returns A Promise of DatabaseBackup
|
|
@@ -164,8 +154,7 @@ class API extends API$1 {
|
|
|
164
154
|
unmarshalDatabaseBackup
|
|
165
155
|
);
|
|
166
156
|
/**
|
|
167
|
-
* Delete a database backup. Delete a backup, specified by its database backup
|
|
168
|
-
* ID and region. Deleting a backup is permanent, and cannot be undone.
|
|
157
|
+
* Delete a database backup. Delete a backup, specified by its database backup ID and region. Deleting a backup is permanent, and cannot be undone.
|
|
169
158
|
*
|
|
170
159
|
* @param request - The request {@link DeleteDatabaseBackupRequest}
|
|
171
160
|
* @returns A Promise of DatabaseBackup
|
|
@@ -178,10 +167,7 @@ class API extends API$1 {
|
|
|
178
167
|
unmarshalDatabaseBackup
|
|
179
168
|
);
|
|
180
169
|
/**
|
|
181
|
-
* Restore a database backup. Launch the process of restoring database backup.
|
|
182
|
-
* You must specify the `instance_id` of the Database Instance of destination,
|
|
183
|
-
* where the backup will be restored. Note that large database backups can
|
|
184
|
-
* take up to several hours to restore.
|
|
170
|
+
* 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.
|
|
185
171
|
*
|
|
186
172
|
* @param request - The request {@link RestoreDatabaseBackupRequest}
|
|
187
173
|
* @returns A Promise of DatabaseBackup
|
|
@@ -198,9 +184,7 @@ class API extends API$1 {
|
|
|
198
184
|
unmarshalDatabaseBackup
|
|
199
185
|
);
|
|
200
186
|
/**
|
|
201
|
-
* Export a database backup. Export a backup, specified by the
|
|
202
|
-
* `database_backup_id` and the `region` parameters. The download URL is
|
|
203
|
-
* returned in the response.
|
|
187
|
+
* 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.
|
|
204
188
|
*
|
|
205
189
|
* @param request - The request {@link ExportDatabaseBackupRequest}
|
|
206
190
|
* @returns A Promise of DatabaseBackup
|
|
@@ -215,10 +199,7 @@ class API extends API$1 {
|
|
|
215
199
|
unmarshalDatabaseBackup
|
|
216
200
|
);
|
|
217
201
|
/**
|
|
218
|
-
* Upgrade a Database Instance. Upgrade your current Database Instance
|
|
219
|
-
* specifications like node type, high availability, volume, or the database
|
|
220
|
-
* engine version. Note that upon upgrade the `enable_ha` parameter can only
|
|
221
|
-
* be set to `true`.
|
|
202
|
+
* 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`.
|
|
222
203
|
*
|
|
223
204
|
* @param request - The request {@link UpgradeInstanceRequest}
|
|
224
205
|
* @returns A Promise of Instance
|
|
@@ -254,24 +235,14 @@ class API extends API$1 {
|
|
|
254
235
|
unmarshalListInstancesResponse
|
|
255
236
|
);
|
|
256
237
|
/**
|
|
257
|
-
* List Database Instances. List all Database Instances in the specified
|
|
258
|
-
* region, for a given Scaleway Organization or Scaleway Project. By default,
|
|
259
|
-
* the Database Instances returned in the list are ordered by creation date in
|
|
260
|
-
* ascending order, though this can be modified via the order_by field. You
|
|
261
|
-
* can define additional parameters for your query, such as `tags` and `name`.
|
|
262
|
-
* For the `name` parameter, the value you include will be checked against the
|
|
263
|
-
* whole name string to see if it includes the string you put in the
|
|
264
|
-
* parameter.
|
|
238
|
+
* 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.
|
|
265
239
|
*
|
|
266
240
|
* @param request - The request {@link ListInstancesRequest}
|
|
267
241
|
* @returns A Promise of ListInstancesResponse
|
|
268
242
|
*/
|
|
269
243
|
listInstances = (request = {}) => enrichForPagination("instances", this.pageOfListInstances, request);
|
|
270
244
|
/**
|
|
271
|
-
* Get a Database Instance. Retrieve information about a given Database
|
|
272
|
-
* Instance, specified by the `region` and `instance_id` parameters. Its full
|
|
273
|
-
* details, including name, status, IP address and port, are returned in the
|
|
274
|
-
* response object.
|
|
245
|
+
* 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.
|
|
275
246
|
*
|
|
276
247
|
* @param request - The request {@link GetInstanceRequest}
|
|
277
248
|
* @returns A Promise of Instance
|
|
@@ -299,9 +270,7 @@ class API extends API$1 {
|
|
|
299
270
|
options
|
|
300
271
|
);
|
|
301
272
|
/**
|
|
302
|
-
* Create a Database Instance. Create a new Database Instance. You must set
|
|
303
|
-
* the `engine`, `user_name`, `password` and `node_type` parameters.
|
|
304
|
-
* Optionally, you can specify the volume type and size.
|
|
273
|
+
* 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.
|
|
305
274
|
*
|
|
306
275
|
* @param request - The request {@link CreateInstanceRequest}
|
|
307
276
|
* @returns A Promise of Instance
|
|
@@ -318,8 +287,7 @@ class API extends API$1 {
|
|
|
318
287
|
unmarshalInstance
|
|
319
288
|
);
|
|
320
289
|
/**
|
|
321
|
-
* Update a Database Instance. Update the parameters of a Database Instance,
|
|
322
|
-
* including name, tags and backup schedule details.
|
|
290
|
+
* Update a Database Instance. Update the parameters of a Database Instance, including name, tags and backup schedule details.
|
|
323
291
|
*
|
|
324
292
|
* @param request - The request {@link UpdateInstanceRequest}
|
|
325
293
|
* @returns A Promise of Instance
|
|
@@ -336,10 +304,7 @@ class API extends API$1 {
|
|
|
336
304
|
unmarshalInstance
|
|
337
305
|
);
|
|
338
306
|
/**
|
|
339
|
-
* Delete a Database Instance. Delete a given Database Instance, specified by
|
|
340
|
-
* the `region` and `instance_id` parameters. Deleting a Database Instance is
|
|
341
|
-
* permanent, and cannot be undone. Note that upon deletion all your data will
|
|
342
|
-
* be lost.
|
|
307
|
+
* 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.
|
|
343
308
|
*
|
|
344
309
|
* @param request - The request {@link DeleteInstanceRequest}
|
|
345
310
|
* @returns A Promise of Instance
|
|
@@ -352,11 +317,7 @@ class API extends API$1 {
|
|
|
352
317
|
unmarshalInstance
|
|
353
318
|
);
|
|
354
319
|
/**
|
|
355
|
-
* Clone a Database Instance. Clone a given Database Instance, specified by
|
|
356
|
-
* the `region` and `instance_id` parameters. The clone feature allows you to
|
|
357
|
-
* create a new Database Instance from an existing one. The clone includes all
|
|
358
|
-
* existing databases, users and permissions. You can create a clone on a
|
|
359
|
-
* Database Instance bigger than your current one.
|
|
320
|
+
* 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.
|
|
360
321
|
*
|
|
361
322
|
* @param request - The request {@link CloneInstanceRequest}
|
|
362
323
|
* @returns A Promise of Instance
|
|
@@ -373,9 +334,7 @@ class API extends API$1 {
|
|
|
373
334
|
unmarshalInstance
|
|
374
335
|
);
|
|
375
336
|
/**
|
|
376
|
-
* Restart Database Instance. Restart a given Database Instance, specified by
|
|
377
|
-
* the `region` and `instance_id` parameters. The status of the Database
|
|
378
|
-
* Instance returned in the response.
|
|
337
|
+
* 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.
|
|
379
338
|
*
|
|
380
339
|
* @param request - The request {@link RestartInstanceRequest}
|
|
381
340
|
* @returns A Promise of Instance
|
|
@@ -390,9 +349,7 @@ class API extends API$1 {
|
|
|
390
349
|
unmarshalInstance
|
|
391
350
|
);
|
|
392
351
|
/**
|
|
393
|
-
* Get the TLS certificate of a Database Instance. Retrieve information about
|
|
394
|
-
* the TLS certificate of a given Database Instance. Details like name and
|
|
395
|
-
* content are returned in the response.
|
|
352
|
+
* 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.
|
|
396
353
|
*
|
|
397
354
|
* @param request - The request {@link GetInstanceCertificateRequest}
|
|
398
355
|
* @returns A Promise of Blob
|
|
@@ -404,11 +361,7 @@ class API extends API$1 {
|
|
|
404
361
|
responseType: "blob"
|
|
405
362
|
});
|
|
406
363
|
/**
|
|
407
|
-
* Renew the TLS certificate of a Database Instance. Renew a TLS for a
|
|
408
|
-
* Database Instance. Renewing a certificate means that you will not be able
|
|
409
|
-
* to connect to your Database Instance using the previous certificate. You
|
|
410
|
-
* will also need to download and update the new certificate for all database
|
|
411
|
-
* clients.
|
|
364
|
+
* 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.
|
|
412
365
|
*
|
|
413
366
|
* @param request - The request {@link RenewInstanceCertificateRequest}
|
|
414
367
|
*/
|
|
@@ -419,9 +372,7 @@ class API extends API$1 {
|
|
|
419
372
|
path: `/rdb/v1/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/instances/${validatePathParam("instanceId", request.instanceId)}/renew-certificate`
|
|
420
373
|
});
|
|
421
374
|
/**
|
|
422
|
-
* Get Database Instance metrics. Retrieve the time series metrics of a given
|
|
423
|
-
* Database Instance. You can define the period from which to retrieve metrics
|
|
424
|
-
* by specifying the `start_date` and `end_date`.
|
|
375
|
+
* 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`.
|
|
425
376
|
*
|
|
426
377
|
* @param request - The request {@link GetInstanceMetricsRequest}
|
|
427
378
|
* @returns A Promise of InstanceMetrics
|
|
@@ -439,9 +390,7 @@ class API extends API$1 {
|
|
|
439
390
|
unmarshalInstanceMetrics
|
|
440
391
|
);
|
|
441
392
|
/**
|
|
442
|
-
* Create a Read Replica. Create a new Read Replica of a Database Instance.
|
|
443
|
-
* You must specify the `region` and the `instance_id`. You can only create a
|
|
444
|
-
* maximum of 3 Read Replicas per Database Instance.
|
|
393
|
+
* 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.
|
|
445
394
|
*
|
|
446
395
|
* @param request - The request {@link CreateReadReplicaRequest}
|
|
447
396
|
* @returns A Promise of ReadReplica
|
|
@@ -458,9 +407,7 @@ class API extends API$1 {
|
|
|
458
407
|
unmarshalReadReplica
|
|
459
408
|
);
|
|
460
409
|
/**
|
|
461
|
-
* Get a Read Replica. Retrieve information about a Database Instance Read
|
|
462
|
-
* Replica. Full details about the Read Replica, like `endpoints`, `status`
|
|
463
|
-
* and `region` are returned in the response.
|
|
410
|
+
* 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.
|
|
464
411
|
*
|
|
465
412
|
* @param request - The request {@link GetReadReplicaRequest}
|
|
466
413
|
* @returns A Promise of ReadReplica
|
|
@@ -488,9 +435,7 @@ class API extends API$1 {
|
|
|
488
435
|
options
|
|
489
436
|
);
|
|
490
437
|
/**
|
|
491
|
-
* Delete a Read Replica. Delete a Read Replica of a Database Instance. You
|
|
492
|
-
* must specify the `region` and `read_replica_id` parameters of the Read
|
|
493
|
-
* Replica you want to delete.
|
|
438
|
+
* 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.
|
|
494
439
|
*
|
|
495
440
|
* @param request - The request {@link DeleteReadReplicaRequest}
|
|
496
441
|
* @returns A Promise of ReadReplica
|
|
@@ -503,15 +448,12 @@ class API extends API$1 {
|
|
|
503
448
|
unmarshalReadReplica
|
|
504
449
|
);
|
|
505
450
|
/**
|
|
506
|
-
|
|
507
|
-
|
|
508
|
-
|
|
509
|
-
|
|
510
|
-
|
|
511
|
-
|
|
512
|
-
* @param request - The request {@link ResetReadReplicaRequest}
|
|
513
|
-
* @returns A Promise of ReadReplica
|
|
514
|
-
*/
|
|
451
|
+
* 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.
|
|
452
|
+
The configured endpoints do not change.
|
|
453
|
+
*
|
|
454
|
+
* @param request - The request {@link ResetReadReplicaRequest}
|
|
455
|
+
* @returns A Promise of ReadReplica
|
|
456
|
+
*/
|
|
515
457
|
resetReadReplica = (request) => this.client.fetch(
|
|
516
458
|
{
|
|
517
459
|
body: "{}",
|
|
@@ -522,8 +464,7 @@ class API extends API$1 {
|
|
|
522
464
|
unmarshalReadReplica
|
|
523
465
|
);
|
|
524
466
|
/**
|
|
525
|
-
* Promote a Read Replica. Promote a Read Replica to Database Instance
|
|
526
|
-
* automatically.
|
|
467
|
+
* Promote a Read Replica. Promote a Read Replica to Database Instance automatically.
|
|
527
468
|
*
|
|
528
469
|
* @param request - The request {@link PromoteReadReplicaRequest}
|
|
529
470
|
* @returns A Promise of Instance
|
|
@@ -538,9 +479,7 @@ class API extends API$1 {
|
|
|
538
479
|
unmarshalInstance
|
|
539
480
|
);
|
|
540
481
|
/**
|
|
541
|
-
* Create an endpoint for a Read Replica. Create a new endpoint for a Read
|
|
542
|
-
* Replica. Read Replicas can have at most one direct access and one Private
|
|
543
|
-
* Network endpoint.
|
|
482
|
+
* 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.
|
|
544
483
|
*
|
|
545
484
|
* @param request - The request {@link CreateReadReplicaEndpointRequest}
|
|
546
485
|
* @returns A Promise of ReadReplica
|
|
@@ -560,12 +499,7 @@ class API extends API$1 {
|
|
|
560
499
|
unmarshalReadReplica
|
|
561
500
|
);
|
|
562
501
|
/**
|
|
563
|
-
* Prepare logs of a Database Instance. Prepare your Database Instance logs.
|
|
564
|
-
* You can define the `start_date` and `end_date` parameters for your query.
|
|
565
|
-
* The download URL is returned in the response. Logs are recorded from 00h00
|
|
566
|
-
* to 23h59 and then aggregated in a `.log` file once a day. Therefore, even
|
|
567
|
-
* if you specify a timeframe from which you want to get the logs, you will
|
|
568
|
-
* receive logs from the full 24 hours.
|
|
502
|
+
* 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.
|
|
569
503
|
*
|
|
570
504
|
* @param request - The request {@link PrepareInstanceLogsRequest}
|
|
571
505
|
* @returns A Promise of PrepareInstanceLogsResponse
|
|
@@ -582,10 +516,7 @@ class API extends API$1 {
|
|
|
582
516
|
unmarshalPrepareInstanceLogsResponse
|
|
583
517
|
);
|
|
584
518
|
/**
|
|
585
|
-
* List available logs of a Database Instance. List the available logs of a
|
|
586
|
-
* Database Instance. By default, the logs returned in the list are ordered by
|
|
587
|
-
* creation date in ascending order, though this can be modified via the
|
|
588
|
-
* order_by field.
|
|
519
|
+
* 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.
|
|
589
520
|
*
|
|
590
521
|
* @param request - The request {@link ListInstanceLogsRequest}
|
|
591
522
|
* @returns A Promise of ListInstanceLogsResponse
|
|
@@ -599,10 +530,7 @@ class API extends API$1 {
|
|
|
599
530
|
unmarshalListInstanceLogsResponse
|
|
600
531
|
);
|
|
601
532
|
/**
|
|
602
|
-
* Get given logs of a Database Instance. Retrieve information about the logs
|
|
603
|
-
* of a Database Instance. Specify the `instance_log_id` and `region` in your
|
|
604
|
-
* request to get information such as `download_url`, `status`, `expires_at`
|
|
605
|
-
* and `created_at` about your logs in the response.
|
|
533
|
+
* 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.
|
|
606
534
|
*
|
|
607
535
|
* @param request - The request {@link GetInstanceLogRequest}
|
|
608
536
|
* @returns A Promise of InstanceLog
|
|
@@ -630,9 +558,7 @@ class API extends API$1 {
|
|
|
630
558
|
options
|
|
631
559
|
);
|
|
632
560
|
/**
|
|
633
|
-
* Purge remote Database Instance logs. Purge a given remote log from a
|
|
634
|
-
* Database Instance. You can specify the `log_name` of the log you wish to
|
|
635
|
-
* clean from your Database Instance.
|
|
561
|
+
* 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.
|
|
636
562
|
*
|
|
637
563
|
* @param request - The request {@link PurgeInstanceLogsRequest}
|
|
638
564
|
*/
|
|
@@ -645,9 +571,7 @@ class API extends API$1 {
|
|
|
645
571
|
path: `/rdb/v1/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/instances/${validatePathParam("instanceId", request.instanceId)}/purge-logs`
|
|
646
572
|
});
|
|
647
573
|
/**
|
|
648
|
-
* List remote Database Instance logs details. List remote log details. By
|
|
649
|
-
* default, the details returned in the list are ordered by creation date in
|
|
650
|
-
* ascending order, though this can be modified via the order_by field.
|
|
574
|
+
* 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.
|
|
651
575
|
*
|
|
652
576
|
* @param request - The request {@link ListInstanceLogsDetailsRequest}
|
|
653
577
|
* @returns A Promise of ListInstanceLogsDetailsResponse
|
|
@@ -660,9 +584,7 @@ class API extends API$1 {
|
|
|
660
584
|
unmarshalListInstanceLogsDetailsResponse
|
|
661
585
|
);
|
|
662
586
|
/**
|
|
663
|
-
* Add Database Instance advanced settings. Add an advanced setting to a
|
|
664
|
-
* Database Instance. You must set the `name` and the `value` of each
|
|
665
|
-
* setting.
|
|
587
|
+
* Add Database Instance advanced settings. Add an advanced setting to a Database Instance. You must set the `name` and the `value` of each setting.
|
|
666
588
|
*
|
|
667
589
|
* @param request - The request {@link AddInstanceSettingsRequest}
|
|
668
590
|
* @returns A Promise of AddInstanceSettingsResponse
|
|
@@ -679,9 +601,7 @@ class API extends API$1 {
|
|
|
679
601
|
unmarshalAddInstanceSettingsResponse
|
|
680
602
|
);
|
|
681
603
|
/**
|
|
682
|
-
* Delete Database Instance advanced settings. Delete an advanced setting in a
|
|
683
|
-
* Database Instance. You must specify the names of the settings you want to
|
|
684
|
-
* delete in the request.
|
|
604
|
+
* 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.
|
|
685
605
|
*
|
|
686
606
|
* @param request - The request {@link DeleteInstanceSettingsRequest}
|
|
687
607
|
* @returns A Promise of DeleteInstanceSettingsResponse
|
|
@@ -698,9 +618,7 @@ class API extends API$1 {
|
|
|
698
618
|
unmarshalDeleteInstanceSettingsResponse
|
|
699
619
|
);
|
|
700
620
|
/**
|
|
701
|
-
* Set Database Instance advanced settings. Update an advanced setting for a
|
|
702
|
-
* Database Instance. Settings added upon database engine initalization can
|
|
703
|
-
* only be defined once, and cannot, therefore, be updated.
|
|
621
|
+
* 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.
|
|
704
622
|
*
|
|
705
623
|
* @param request - The request {@link SetInstanceSettingsRequest}
|
|
706
624
|
* @returns A Promise of SetInstanceSettingsResponse
|
|
@@ -731,18 +649,14 @@ class API extends API$1 {
|
|
|
731
649
|
unmarshalListInstanceACLRulesResponse
|
|
732
650
|
);
|
|
733
651
|
/**
|
|
734
|
-
* List ACL rules of a Database Instance. List the ACL rules for a given
|
|
735
|
-
* Database Instance. The response is an array of ACL objects, each one
|
|
736
|
-
* representing an ACL that denies, allows or redirects traffic based on
|
|
737
|
-
* certain conditions.
|
|
652
|
+
* 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.
|
|
738
653
|
*
|
|
739
654
|
* @param request - The request {@link ListInstanceACLRulesRequest}
|
|
740
655
|
* @returns A Promise of ListInstanceACLRulesResponse
|
|
741
656
|
*/
|
|
742
657
|
listInstanceACLRules = (request) => enrichForPagination("rules", this.pageOfListInstanceACLRules, request);
|
|
743
658
|
/**
|
|
744
|
-
* Add an ACL rule to a Database Instance. Add an additional ACL rule to a
|
|
745
|
-
* Database Instance.
|
|
659
|
+
* Add an ACL rule to a Database Instance. Add an additional ACL rule to a Database Instance.
|
|
746
660
|
*
|
|
747
661
|
* @param request - The request {@link AddInstanceACLRulesRequest}
|
|
748
662
|
* @returns A Promise of AddInstanceACLRulesResponse
|
|
@@ -759,8 +673,7 @@ class API extends API$1 {
|
|
|
759
673
|
unmarshalAddInstanceACLRulesResponse
|
|
760
674
|
);
|
|
761
675
|
/**
|
|
762
|
-
* Set ACL rules for a Database Instance. Replace all the ACL rules of a
|
|
763
|
-
* Database Instance.
|
|
676
|
+
* Set ACL rules for a Database Instance. Replace all the ACL rules of a Database Instance.
|
|
764
677
|
*
|
|
765
678
|
* @param request - The request {@link SetInstanceACLRulesRequest}
|
|
766
679
|
* @returns A Promise of SetInstanceACLRulesResponse
|
|
@@ -777,8 +690,7 @@ class API extends API$1 {
|
|
|
777
690
|
unmarshalSetInstanceACLRulesResponse
|
|
778
691
|
);
|
|
779
692
|
/**
|
|
780
|
-
* Delete ACL rules of a Database Instance. Delete one or more ACL rules of a
|
|
781
|
-
* Database Instance.
|
|
693
|
+
* Delete ACL rules of a Database Instance. Delete one or more ACL rules of a Database Instance.
|
|
782
694
|
*
|
|
783
695
|
* @param request - The request {@link DeleteInstanceACLRulesRequest}
|
|
784
696
|
* @returns A Promise of DeleteInstanceACLRulesResponse
|
|
@@ -811,19 +723,14 @@ class API extends API$1 {
|
|
|
811
723
|
unmarshalListUsersResponse
|
|
812
724
|
);
|
|
813
725
|
/**
|
|
814
|
-
* List users of a Database Instance. List all users of a given Database
|
|
815
|
-
* Instance. By default, the users returned in the list are ordered by
|
|
816
|
-
* creation date in ascending order, though this can be modified via the
|
|
817
|
-
* order_by field.
|
|
726
|
+
* 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.
|
|
818
727
|
*
|
|
819
728
|
* @param request - The request {@link ListUsersRequest}
|
|
820
729
|
* @returns A Promise of ListUsersResponse
|
|
821
730
|
*/
|
|
822
731
|
listUsers = (request) => enrichForPagination("users", this.pageOfListUsers, request);
|
|
823
732
|
/**
|
|
824
|
-
* Create a user for a Database Instance. Create a new user for a Database
|
|
825
|
-
* Instance. You must define the `name`, `password` and `is_admin`
|
|
826
|
-
* parameters.
|
|
733
|
+
* 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.
|
|
827
734
|
*
|
|
828
735
|
* @param request - The request {@link CreateUserRequest}
|
|
829
736
|
* @returns A Promise of User
|
|
@@ -840,9 +747,7 @@ class API extends API$1 {
|
|
|
840
747
|
unmarshalUser
|
|
841
748
|
);
|
|
842
749
|
/**
|
|
843
|
-
* Update a user on a Database Instance. Update the parameters of a user on a
|
|
844
|
-
* Database Instance. You can update the `password` and `is_admin` parameters,
|
|
845
|
-
* but you cannot change the name of the user.
|
|
750
|
+
* 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.
|
|
846
751
|
*
|
|
847
752
|
* @param request - The request {@link UpdateUserRequest}
|
|
848
753
|
* @returns A Promise of User
|
|
@@ -859,9 +764,7 @@ class API extends API$1 {
|
|
|
859
764
|
unmarshalUser
|
|
860
765
|
);
|
|
861
766
|
/**
|
|
862
|
-
* Delete a user on a Database Instance. Delete a given user on a Database
|
|
863
|
-
* Instance. You must specify, in the endpoint, the `region`, `instance_id`
|
|
864
|
-
* and `name` parameters of the user you want to delete.
|
|
767
|
+
* 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.
|
|
865
768
|
*
|
|
866
769
|
* @param request - The request {@link DeleteUserRequest}
|
|
867
770
|
*/
|
|
@@ -888,19 +791,14 @@ class API extends API$1 {
|
|
|
888
791
|
unmarshalListDatabasesResponse
|
|
889
792
|
);
|
|
890
793
|
/**
|
|
891
|
-
* List databases in a Database Instance. List all databases of a given
|
|
892
|
-
* Database Instance. By default, the databases returned in the list are
|
|
893
|
-
* ordered by creation date in ascending order, though this can be modified
|
|
894
|
-
* via the order_by field. You can define additional parameters for your
|
|
895
|
-
* query, such as `name`, `managed` and `owner`.
|
|
794
|
+
* 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`.
|
|
896
795
|
*
|
|
897
796
|
* @param request - The request {@link ListDatabasesRequest}
|
|
898
797
|
* @returns A Promise of ListDatabasesResponse
|
|
899
798
|
*/
|
|
900
799
|
listDatabases = (request) => enrichForPagination("databases", this.pageOfListDatabases, request);
|
|
901
800
|
/**
|
|
902
|
-
* Create a database in a Database Instance. Create a new database. You must
|
|
903
|
-
* define the `name` parameter in the request.
|
|
801
|
+
* Create a database in a Database Instance. Create a new database. You must define the `name` parameter in the request.
|
|
904
802
|
*
|
|
905
803
|
* @param request - The request {@link CreateDatabaseRequest}
|
|
906
804
|
* @returns A Promise of Database
|
|
@@ -917,9 +815,7 @@ class API extends API$1 {
|
|
|
917
815
|
unmarshalDatabase
|
|
918
816
|
);
|
|
919
817
|
/**
|
|
920
|
-
* Delete a database in a Database Instance. Delete a given database on a
|
|
921
|
-
* Database Instance. You must specify, in the endpoint, the `region`,
|
|
922
|
-
* `instance_id` and `name` parameters of the database you want to delete.
|
|
818
|
+
* 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.
|
|
923
819
|
*
|
|
924
820
|
* @param request - The request {@link DeleteDatabaseRequest}
|
|
925
821
|
*/
|
|
@@ -945,20 +841,14 @@ class API extends API$1 {
|
|
|
945
841
|
unmarshalListPrivilegesResponse
|
|
946
842
|
);
|
|
947
843
|
/**
|
|
948
|
-
* List user privileges for a database. List privileges of a user on a
|
|
949
|
-
* database. By default, the details returned in the list are ordered by
|
|
950
|
-
* creation date in ascending order, though this can be modified via the
|
|
951
|
-
* order_by field. You can define additional parameters for your query, such
|
|
952
|
-
* as `database_name` and `user_name`.
|
|
844
|
+
* 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`.
|
|
953
845
|
*
|
|
954
846
|
* @param request - The request {@link ListPrivilegesRequest}
|
|
955
847
|
* @returns A Promise of ListPrivilegesResponse
|
|
956
848
|
*/
|
|
957
849
|
listPrivileges = (request) => enrichForPagination("privileges", this.pageOfListPrivileges, request);
|
|
958
850
|
/**
|
|
959
|
-
* Set user privileges for a database. Set the privileges of a user on a
|
|
960
|
-
* database. You must define `database_name`, `user_name` and `permission` in
|
|
961
|
-
* the request body.
|
|
851
|
+
* 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.
|
|
962
852
|
*
|
|
963
853
|
* @param request - The request {@link SetPrivilegeRequest}
|
|
964
854
|
* @returns A Promise of Privilege
|
|
@@ -994,20 +884,14 @@ class API extends API$1 {
|
|
|
994
884
|
unmarshalListSnapshotsResponse
|
|
995
885
|
);
|
|
996
886
|
/**
|
|
997
|
-
* List snapshots. List snapshots. You can include the `instance_id` or
|
|
998
|
-
* `project_id` in your query to get the list of snapshots for specific
|
|
999
|
-
* Database Instances and/or Projects. By default, the details returned in the
|
|
1000
|
-
* list are ordered by creation date in ascending order, though this can be
|
|
1001
|
-
* modified via the `order_by` field.
|
|
887
|
+
* 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.
|
|
1002
888
|
*
|
|
1003
889
|
* @param request - The request {@link ListSnapshotsRequest}
|
|
1004
890
|
* @returns A Promise of ListSnapshotsResponse
|
|
1005
891
|
*/
|
|
1006
892
|
listSnapshots = (request = {}) => enrichForPagination("snapshots", this.pageOfListSnapshots, request);
|
|
1007
893
|
/**
|
|
1008
|
-
* Get a Database Instance snapshot. Retrieve information about a given
|
|
1009
|
-
* snapshot, specified by its `snapshot_id` and `region`. Full details about
|
|
1010
|
-
* the snapshot, like size and expiration date, are returned in the response.
|
|
894
|
+
* 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.
|
|
1011
895
|
*
|
|
1012
896
|
* @param request - The request {@link GetSnapshotRequest}
|
|
1013
897
|
* @returns A Promise of Snapshot
|
|
@@ -1035,8 +919,7 @@ class API extends API$1 {
|
|
|
1035
919
|
options
|
|
1036
920
|
);
|
|
1037
921
|
/**
|
|
1038
|
-
* Create a Database Instance snapshot. Create a new snapshot of a Database
|
|
1039
|
-
* Instance. You must define the `name` parameter in the request.
|
|
922
|
+
* Create a Database Instance snapshot. Create a new snapshot of a Database Instance. You must define the `name` parameter in the request.
|
|
1040
923
|
*
|
|
1041
924
|
* @param request - The request {@link CreateSnapshotRequest}
|
|
1042
925
|
* @returns A Promise of Snapshot
|
|
@@ -1053,9 +936,7 @@ class API extends API$1 {
|
|
|
1053
936
|
unmarshalSnapshot
|
|
1054
937
|
);
|
|
1055
938
|
/**
|
|
1056
|
-
* Update a Database Instance snapshot. Update the parameters of a snapshot of
|
|
1057
|
-
* a Database Instance. You can update the `name` and `expires_at`
|
|
1058
|
-
* parameters.
|
|
939
|
+
* Update a Database Instance snapshot. Update the parameters of a snapshot of a Database Instance. You can update the `name` and `expires_at` parameters.
|
|
1059
940
|
*
|
|
1060
941
|
* @param request - The request {@link UpdateSnapshotRequest}
|
|
1061
942
|
* @returns A Promise of Snapshot
|
|
@@ -1072,9 +953,7 @@ class API extends API$1 {
|
|
|
1072
953
|
unmarshalSnapshot
|
|
1073
954
|
);
|
|
1074
955
|
/**
|
|
1075
|
-
* Delete a Database Instance snapshot. Delete a given snapshot of a Database
|
|
1076
|
-
* Instance. You must specify, in the endpoint, the `region` and `snapshot_id`
|
|
1077
|
-
* parameters of the snapshot you want to delete.
|
|
956
|
+
* 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.
|
|
1078
957
|
*
|
|
1079
958
|
* @param request - The request {@link DeleteSnapshotRequest}
|
|
1080
959
|
* @returns A Promise of Snapshot
|
|
@@ -1087,14 +966,7 @@ class API extends API$1 {
|
|
|
1087
966
|
unmarshalSnapshot
|
|
1088
967
|
);
|
|
1089
968
|
/**
|
|
1090
|
-
* Create a new Database Instance from a snapshot. Restore a snapshot. When
|
|
1091
|
-
* you restore a snapshot, a new Instance is created and billed to your
|
|
1092
|
-
* account. Note that is possible to select a larger node type for your new
|
|
1093
|
-
* Database Instance. However, the Block volume size will be the same as the
|
|
1094
|
-
* size of the restored snapshot. All Instance settings will be restored if
|
|
1095
|
-
* you chose a node type with the same or more memory size than the initial
|
|
1096
|
-
* Instance. Settings will be reset to the default if your node type has less
|
|
1097
|
-
* memory.
|
|
969
|
+
* 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.
|
|
1098
970
|
*
|
|
1099
971
|
* @param request - The request {@link CreateInstanceFromSnapshotRequest}
|
|
1100
972
|
* @returns A Promise of Instance
|
|
@@ -1114,9 +986,7 @@ class API extends API$1 {
|
|
|
1114
986
|
unmarshalInstance
|
|
1115
987
|
);
|
|
1116
988
|
/**
|
|
1117
|
-
* Create a new Database Instance endpoint. Create a new endpoint for a
|
|
1118
|
-
* Database Instance. You can add `load_balancer` and `private_network`
|
|
1119
|
-
* specifications to the body of the request.
|
|
989
|
+
* 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.
|
|
1120
990
|
*
|
|
1121
991
|
* @param request - The request {@link CreateEndpointRequest}
|
|
1122
992
|
* @returns A Promise of Endpoint
|
|
@@ -1133,10 +1003,7 @@ class API extends API$1 {
|
|
|
1133
1003
|
unmarshalEndpoint
|
|
1134
1004
|
);
|
|
1135
1005
|
/**
|
|
1136
|
-
* Delete a Database Instance endpoint. Delete the endpoint of a Database
|
|
1137
|
-
* Instance. You must specify the `region` and `endpoint_id` parameters of the
|
|
1138
|
-
* endpoint you want to delete. Note that might need to update any environment
|
|
1139
|
-
* configurations that point to the deleted endpoint.
|
|
1006
|
+
* 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.
|
|
1140
1007
|
*
|
|
1141
1008
|
* @param request - The request {@link DeleteEndpointRequest}
|
|
1142
1009
|
*/
|
|
@@ -1145,10 +1012,7 @@ class API extends API$1 {
|
|
|
1145
1012
|
path: `/rdb/v1/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/endpoints/${validatePathParam("endpointId", request.endpointId)}`
|
|
1146
1013
|
});
|
|
1147
1014
|
/**
|
|
1148
|
-
* Get a Database Instance endpoint. Retrieve information about a Database
|
|
1149
|
-
* Instance endpoint. Full details about the endpoint, like `ip`, `port`,
|
|
1150
|
-
* `private_network` and `load_balancer` specifications are returned in the
|
|
1151
|
-
* response.
|
|
1015
|
+
* 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.
|
|
1152
1016
|
*
|
|
1153
1017
|
* @param request - The request {@link GetEndpointRequest}
|
|
1154
1018
|
* @returns A Promise of Endpoint
|
|
@@ -1178,11 +1042,7 @@ class API extends API$1 {
|
|
|
1178
1042
|
unmarshalEndpoint
|
|
1179
1043
|
);
|
|
1180
1044
|
/**
|
|
1181
|
-
* Apply Database Instance maintenance. Apply maintenance tasks to your
|
|
1182
|
-
* Database Instance. This will trigger pending maintenance tasks to start in
|
|
1183
|
-
* your Database Instance and can generate service interruption. Maintenance
|
|
1184
|
-
* tasks can be applied between `starts_at` and `stops_at` times, and are run
|
|
1185
|
-
* directly by Scaleway at `forced_at` timestamp.
|
|
1045
|
+
* 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.
|
|
1186
1046
|
*
|
|
1187
1047
|
* @param request - The request {@link ApplyInstanceMaintenanceRequest}
|
|
1188
1048
|
* @returns A Promise of Maintenance
|