@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
|
@@ -15,9 +15,7 @@ class API extends api.API {
|
|
|
15
15
|
/** Lists the available regions of the API. */
|
|
16
16
|
static LOCALITIES = ["fr-par"];
|
|
17
17
|
/**
|
|
18
|
-
* Create a new Serverless SQL Database. You must provide the following
|
|
19
|
-
* parameters: `organization_id`, `project_id`, `name`, `cpu_min`, `cpu_max`.
|
|
20
|
-
* You can also provide `from_backup_id` to create a database from a backup.
|
|
18
|
+
* Create a new Serverless SQL Database. You must provide the following parameters: `organization_id`, `project_id`, `name`, `cpu_min`, `cpu_max`. You can also provide `from_backup_id` to create a database from a backup.
|
|
21
19
|
*
|
|
22
20
|
* @param request - The request {@link CreateDatabaseRequest}
|
|
23
21
|
* @returns A Promise of Database
|
|
@@ -34,8 +32,7 @@ class API extends api.API {
|
|
|
34
32
|
marshalling_gen.unmarshalDatabase
|
|
35
33
|
);
|
|
36
34
|
/**
|
|
37
|
-
* Get a database information. Retrieve information about your Serverless SQL
|
|
38
|
-
* Database. You must provide the `database_id` parameter.
|
|
35
|
+
* Get a database information. Retrieve information about your Serverless SQL Database. You must provide the `database_id` parameter.
|
|
39
36
|
*
|
|
40
37
|
* @param request - The request {@link GetDatabaseRequest}
|
|
41
38
|
* @returns A Promise of Database
|
|
@@ -63,8 +60,7 @@ class API extends api.API {
|
|
|
63
60
|
options
|
|
64
61
|
);
|
|
65
62
|
/**
|
|
66
|
-
* Delete a database. Deletes a database. You must provide the `database_id`
|
|
67
|
-
* parameter. All data stored in the database will be permanently deleted.
|
|
63
|
+
* Delete a database. Deletes a database. You must provide the `database_id` parameter. All data stored in the database will be permanently deleted.
|
|
68
64
|
*
|
|
69
65
|
* @param request - The request {@link DeleteDatabaseRequest}
|
|
70
66
|
* @returns A Promise of Database
|
|
@@ -95,20 +91,14 @@ class API extends api.API {
|
|
|
95
91
|
marshalling_gen.unmarshalListDatabasesResponse
|
|
96
92
|
);
|
|
97
93
|
/**
|
|
98
|
-
* List your Serverless SQL Databases. List all Serverless SQL Databases for a
|
|
99
|
-
* given Scaleway Organization or Scaleway Project. By default, the databases
|
|
100
|
-
* returned in the list are ordered by creation date in ascending order,
|
|
101
|
-
* though this can be modified via the order_by field. For the `name`
|
|
102
|
-
* parameter, the value you include will be checked against the whole name
|
|
103
|
-
* string to see if it includes the string you put in the parameter.
|
|
94
|
+
* List your Serverless SQL Databases. List all Serverless SQL Databases for a given Scaleway Organization or Scaleway Project. 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. 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.
|
|
104
95
|
*
|
|
105
96
|
* @param request - The request {@link ListDatabasesRequest}
|
|
106
97
|
* @returns A Promise of ListDatabasesResponse
|
|
107
98
|
*/
|
|
108
99
|
listDatabases = (request = {}) => resourcePaginator.enrichForPagination("databases", this.pageOfListDatabases, request);
|
|
109
100
|
/**
|
|
110
|
-
* Update database information. Update CPU limits of your Serverless SQL
|
|
111
|
-
* Database. You must provide the `database_id` parameter.
|
|
101
|
+
* Update database information. Update CPU limits of your Serverless SQL Database. You must provide the `database_id` parameter.
|
|
112
102
|
*
|
|
113
103
|
* @param request - The request {@link UpdateDatabaseRequest}
|
|
114
104
|
* @returns A Promise of Database
|
|
@@ -125,8 +115,7 @@ class API extends api.API {
|
|
|
125
115
|
marshalling_gen.unmarshalDatabase
|
|
126
116
|
);
|
|
127
117
|
/**
|
|
128
|
-
* Restore a database from a backup. Restore a database from a backup. You
|
|
129
|
-
* must provide the `backup_id` parameter.
|
|
118
|
+
* Restore a database from a backup. Restore a database from a backup. You must provide the `backup_id` parameter.
|
|
130
119
|
*
|
|
131
120
|
* @param request - The request {@link RestoreDatabaseFromBackupRequest}
|
|
132
121
|
* @returns A Promise of Database
|
|
@@ -146,9 +135,7 @@ class API extends api.API {
|
|
|
146
135
|
marshalling_gen.unmarshalDatabase
|
|
147
136
|
);
|
|
148
137
|
/**
|
|
149
|
-
* Get a database backup information. Retrieve information about your
|
|
150
|
-
* Serverless SQL Database backup. You must provide the `backup_id`
|
|
151
|
-
* parameter.
|
|
138
|
+
* Get a database backup information. Retrieve information about your Serverless SQL Database backup. You must provide the `backup_id` parameter.
|
|
152
139
|
*
|
|
153
140
|
* @param request - The request {@link GetDatabaseBackupRequest}
|
|
154
141
|
* @returns A Promise of DatabaseBackup
|
|
@@ -176,19 +163,14 @@ class API extends api.API {
|
|
|
176
163
|
marshalling_gen.unmarshalListDatabaseBackupsResponse
|
|
177
164
|
);
|
|
178
165
|
/**
|
|
179
|
-
* List your Serverless SQL Database backups. List all Serverless SQL Database
|
|
180
|
-
* backups for a given Scaleway Project or Database. By default, the backups
|
|
181
|
-
* returned in the list are ordered by creation date in descending order,
|
|
182
|
-
* though this can be modified via the order_by field.
|
|
166
|
+
* List your Serverless SQL Database backups. List all Serverless SQL Database backups for a given Scaleway Project or Database. By default, the backups returned in the list are ordered by creation date in descending order, though this can be modified via the order_by field.
|
|
183
167
|
*
|
|
184
168
|
* @param request - The request {@link ListDatabaseBackupsRequest}
|
|
185
169
|
* @returns A Promise of ListDatabaseBackupsResponse
|
|
186
170
|
*/
|
|
187
171
|
listDatabaseBackups = (request) => resourcePaginator.enrichForPagination("backups", this.pageOfListDatabaseBackups, request);
|
|
188
172
|
/**
|
|
189
|
-
* Export a database backup. Export a database backup providing a download
|
|
190
|
-
* link once the export process is completed. You must provide the `backup_id`
|
|
191
|
-
* parameter.
|
|
173
|
+
* Export a database backup. Export a database backup providing a download link once the export process is completed. You must provide the `backup_id` parameter.
|
|
192
174
|
*
|
|
193
175
|
* @param request - The request {@link ExportDatabaseBackupRequest}
|
|
194
176
|
* @returns A Promise of DatabaseBackup
|
|
@@ -3,24 +3,21 @@ import type { Region as ScwRegion, WaitForOptions } from '@scaleway/sdk-client';
|
|
|
3
3
|
import type { CreateDatabaseRequest, Database, DatabaseBackup, DeleteDatabaseRequest, ExportDatabaseBackupRequest, GetDatabaseBackupRequest, GetDatabaseRequest, ListDatabaseBackupsRequest, ListDatabaseBackupsResponse, ListDatabasesRequest, ListDatabasesResponse, RestoreDatabaseFromBackupRequest, UpdateDatabaseRequest } from './types.gen';
|
|
4
4
|
/**
|
|
5
5
|
* Serverless SQL Databases API.
|
|
6
|
-
|
|
7
|
-
|
|
6
|
+
|
|
7
|
+
This API allows you to manage your Serverless SQL Databases.
|
|
8
8
|
*/
|
|
9
9
|
export declare class API extends ParentAPI {
|
|
10
10
|
/** Lists the available regions of the API. */
|
|
11
11
|
static readonly LOCALITIES: ScwRegion[];
|
|
12
12
|
/**
|
|
13
|
-
* Create a new Serverless SQL Database. You must provide the following
|
|
14
|
-
* parameters: `organization_id`, `project_id`, `name`, `cpu_min`, `cpu_max`.
|
|
15
|
-
* You can also provide `from_backup_id` to create a database from a backup.
|
|
13
|
+
* Create a new Serverless SQL Database. You must provide the following parameters: `organization_id`, `project_id`, `name`, `cpu_min`, `cpu_max`. You can also provide `from_backup_id` to create a database from a backup.
|
|
16
14
|
*
|
|
17
15
|
* @param request - The request {@link CreateDatabaseRequest}
|
|
18
16
|
* @returns A Promise of Database
|
|
19
17
|
*/
|
|
20
18
|
createDatabase: (request: Readonly<CreateDatabaseRequest>) => Promise<Database>;
|
|
21
19
|
/**
|
|
22
|
-
* Get a database information. Retrieve information about your Serverless SQL
|
|
23
|
-
* Database. You must provide the `database_id` parameter.
|
|
20
|
+
* Get a database information. Retrieve information about your Serverless SQL Database. You must provide the `database_id` parameter.
|
|
24
21
|
*
|
|
25
22
|
* @param request - The request {@link GetDatabaseRequest}
|
|
26
23
|
* @returns A Promise of Database
|
|
@@ -35,8 +32,7 @@ export declare class API extends ParentAPI {
|
|
|
35
32
|
*/
|
|
36
33
|
waitForDatabase: (request: Readonly<GetDatabaseRequest>, options?: Readonly<WaitForOptions<Database>>) => Promise<Database>;
|
|
37
34
|
/**
|
|
38
|
-
* Delete a database. Deletes a database. You must provide the `database_id`
|
|
39
|
-
* parameter. All data stored in the database will be permanently deleted.
|
|
35
|
+
* Delete a database. Deletes a database. You must provide the `database_id` parameter. All data stored in the database will be permanently deleted.
|
|
40
36
|
*
|
|
41
37
|
* @param request - The request {@link DeleteDatabaseRequest}
|
|
42
38
|
* @returns A Promise of Database
|
|
@@ -44,12 +40,7 @@ export declare class API extends ParentAPI {
|
|
|
44
40
|
deleteDatabase: (request: Readonly<DeleteDatabaseRequest>) => Promise<Database>;
|
|
45
41
|
protected pageOfListDatabases: (request?: Readonly<ListDatabasesRequest>) => Promise<ListDatabasesResponse>;
|
|
46
42
|
/**
|
|
47
|
-
* List your Serverless SQL Databases. List all Serverless SQL Databases for a
|
|
48
|
-
* given Scaleway Organization or Scaleway Project. By default, the databases
|
|
49
|
-
* returned in the list are ordered by creation date in ascending order,
|
|
50
|
-
* though this can be modified via the order_by field. For the `name`
|
|
51
|
-
* parameter, the value you include will be checked against the whole name
|
|
52
|
-
* string to see if it includes the string you put in the parameter.
|
|
43
|
+
* List your Serverless SQL Databases. List all Serverless SQL Databases for a given Scaleway Organization or Scaleway Project. 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. 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.
|
|
53
44
|
*
|
|
54
45
|
* @param request - The request {@link ListDatabasesRequest}
|
|
55
46
|
* @returns A Promise of ListDatabasesResponse
|
|
@@ -59,25 +50,21 @@ export declare class API extends ParentAPI {
|
|
|
59
50
|
[Symbol.asyncIterator]: () => AsyncGenerator<Database[], void, void>;
|
|
60
51
|
};
|
|
61
52
|
/**
|
|
62
|
-
* Update database information. Update CPU limits of your Serverless SQL
|
|
63
|
-
* Database. You must provide the `database_id` parameter.
|
|
53
|
+
* Update database information. Update CPU limits of your Serverless SQL Database. You must provide the `database_id` parameter.
|
|
64
54
|
*
|
|
65
55
|
* @param request - The request {@link UpdateDatabaseRequest}
|
|
66
56
|
* @returns A Promise of Database
|
|
67
57
|
*/
|
|
68
58
|
updateDatabase: (request: Readonly<UpdateDatabaseRequest>) => Promise<Database>;
|
|
69
59
|
/**
|
|
70
|
-
* Restore a database from a backup. Restore a database from a backup. You
|
|
71
|
-
* must provide the `backup_id` parameter.
|
|
60
|
+
* Restore a database from a backup. Restore a database from a backup. You must provide the `backup_id` parameter.
|
|
72
61
|
*
|
|
73
62
|
* @param request - The request {@link RestoreDatabaseFromBackupRequest}
|
|
74
63
|
* @returns A Promise of Database
|
|
75
64
|
*/
|
|
76
65
|
restoreDatabaseFromBackup: (request: Readonly<RestoreDatabaseFromBackupRequest>) => Promise<Database>;
|
|
77
66
|
/**
|
|
78
|
-
* Get a database backup information. Retrieve information about your
|
|
79
|
-
* Serverless SQL Database backup. You must provide the `backup_id`
|
|
80
|
-
* parameter.
|
|
67
|
+
* Get a database backup information. Retrieve information about your Serverless SQL Database backup. You must provide the `backup_id` parameter.
|
|
81
68
|
*
|
|
82
69
|
* @param request - The request {@link GetDatabaseBackupRequest}
|
|
83
70
|
* @returns A Promise of DatabaseBackup
|
|
@@ -85,10 +72,7 @@ export declare class API extends ParentAPI {
|
|
|
85
72
|
getDatabaseBackup: (request: Readonly<GetDatabaseBackupRequest>) => Promise<DatabaseBackup>;
|
|
86
73
|
protected pageOfListDatabaseBackups: (request: Readonly<ListDatabaseBackupsRequest>) => Promise<ListDatabaseBackupsResponse>;
|
|
87
74
|
/**
|
|
88
|
-
* List your Serverless SQL Database backups. List all Serverless SQL Database
|
|
89
|
-
* backups for a given Scaleway Project or Database. By default, the backups
|
|
90
|
-
* returned in the list are ordered by creation date in descending order,
|
|
91
|
-
* though this can be modified via the order_by field.
|
|
75
|
+
* List your Serverless SQL Database backups. List all Serverless SQL Database backups for a given Scaleway Project or Database. By default, the backups returned in the list are ordered by creation date in descending order, though this can be modified via the order_by field.
|
|
92
76
|
*
|
|
93
77
|
* @param request - The request {@link ListDatabaseBackupsRequest}
|
|
94
78
|
* @returns A Promise of ListDatabaseBackupsResponse
|
|
@@ -98,9 +82,7 @@ export declare class API extends ParentAPI {
|
|
|
98
82
|
[Symbol.asyncIterator]: () => AsyncGenerator<DatabaseBackup[], void, void>;
|
|
99
83
|
};
|
|
100
84
|
/**
|
|
101
|
-
* Export a database backup. Export a database backup providing a download
|
|
102
|
-
* link once the export process is completed. You must provide the `backup_id`
|
|
103
|
-
* parameter.
|
|
85
|
+
* Export a database backup. Export a database backup providing a download link once the export process is completed. You must provide the `backup_id` parameter.
|
|
104
86
|
*
|
|
105
87
|
* @param request - The request {@link ExportDatabaseBackupRequest}
|
|
106
88
|
* @returns A Promise of DatabaseBackup
|
|
@@ -13,9 +13,7 @@ class API extends API$1 {
|
|
|
13
13
|
/** Lists the available regions of the API. */
|
|
14
14
|
static LOCALITIES = ["fr-par"];
|
|
15
15
|
/**
|
|
16
|
-
* Create a new Serverless SQL Database. You must provide the following
|
|
17
|
-
* parameters: `organization_id`, `project_id`, `name`, `cpu_min`, `cpu_max`.
|
|
18
|
-
* You can also provide `from_backup_id` to create a database from a backup.
|
|
16
|
+
* Create a new Serverless SQL Database. You must provide the following parameters: `organization_id`, `project_id`, `name`, `cpu_min`, `cpu_max`. You can also provide `from_backup_id` to create a database from a backup.
|
|
19
17
|
*
|
|
20
18
|
* @param request - The request {@link CreateDatabaseRequest}
|
|
21
19
|
* @returns A Promise of Database
|
|
@@ -32,8 +30,7 @@ class API extends API$1 {
|
|
|
32
30
|
unmarshalDatabase
|
|
33
31
|
);
|
|
34
32
|
/**
|
|
35
|
-
* Get a database information. Retrieve information about your Serverless SQL
|
|
36
|
-
* Database. You must provide the `database_id` parameter.
|
|
33
|
+
* Get a database information. Retrieve information about your Serverless SQL Database. You must provide the `database_id` parameter.
|
|
37
34
|
*
|
|
38
35
|
* @param request - The request {@link GetDatabaseRequest}
|
|
39
36
|
* @returns A Promise of Database
|
|
@@ -61,8 +58,7 @@ class API extends API$1 {
|
|
|
61
58
|
options
|
|
62
59
|
);
|
|
63
60
|
/**
|
|
64
|
-
* Delete a database. Deletes a database. You must provide the `database_id`
|
|
65
|
-
* parameter. All data stored in the database will be permanently deleted.
|
|
61
|
+
* Delete a database. Deletes a database. You must provide the `database_id` parameter. All data stored in the database will be permanently deleted.
|
|
66
62
|
*
|
|
67
63
|
* @param request - The request {@link DeleteDatabaseRequest}
|
|
68
64
|
* @returns A Promise of Database
|
|
@@ -93,20 +89,14 @@ class API extends API$1 {
|
|
|
93
89
|
unmarshalListDatabasesResponse
|
|
94
90
|
);
|
|
95
91
|
/**
|
|
96
|
-
* List your Serverless SQL Databases. List all Serverless SQL Databases for a
|
|
97
|
-
* given Scaleway Organization or Scaleway Project. By default, the databases
|
|
98
|
-
* returned in the list are ordered by creation date in ascending order,
|
|
99
|
-
* though this can be modified via the order_by field. For the `name`
|
|
100
|
-
* parameter, the value you include will be checked against the whole name
|
|
101
|
-
* string to see if it includes the string you put in the parameter.
|
|
92
|
+
* List your Serverless SQL Databases. List all Serverless SQL Databases for a given Scaleway Organization or Scaleway Project. 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. 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.
|
|
102
93
|
*
|
|
103
94
|
* @param request - The request {@link ListDatabasesRequest}
|
|
104
95
|
* @returns A Promise of ListDatabasesResponse
|
|
105
96
|
*/
|
|
106
97
|
listDatabases = (request = {}) => enrichForPagination("databases", this.pageOfListDatabases, request);
|
|
107
98
|
/**
|
|
108
|
-
* Update database information. Update CPU limits of your Serverless SQL
|
|
109
|
-
* Database. You must provide the `database_id` parameter.
|
|
99
|
+
* Update database information. Update CPU limits of your Serverless SQL Database. You must provide the `database_id` parameter.
|
|
110
100
|
*
|
|
111
101
|
* @param request - The request {@link UpdateDatabaseRequest}
|
|
112
102
|
* @returns A Promise of Database
|
|
@@ -123,8 +113,7 @@ class API extends API$1 {
|
|
|
123
113
|
unmarshalDatabase
|
|
124
114
|
);
|
|
125
115
|
/**
|
|
126
|
-
* Restore a database from a backup. Restore a database from a backup. You
|
|
127
|
-
* must provide the `backup_id` parameter.
|
|
116
|
+
* Restore a database from a backup. Restore a database from a backup. You must provide the `backup_id` parameter.
|
|
128
117
|
*
|
|
129
118
|
* @param request - The request {@link RestoreDatabaseFromBackupRequest}
|
|
130
119
|
* @returns A Promise of Database
|
|
@@ -144,9 +133,7 @@ class API extends API$1 {
|
|
|
144
133
|
unmarshalDatabase
|
|
145
134
|
);
|
|
146
135
|
/**
|
|
147
|
-
* Get a database backup information. Retrieve information about your
|
|
148
|
-
* Serverless SQL Database backup. You must provide the `backup_id`
|
|
149
|
-
* parameter.
|
|
136
|
+
* Get a database backup information. Retrieve information about your Serverless SQL Database backup. You must provide the `backup_id` parameter.
|
|
150
137
|
*
|
|
151
138
|
* @param request - The request {@link GetDatabaseBackupRequest}
|
|
152
139
|
* @returns A Promise of DatabaseBackup
|
|
@@ -174,19 +161,14 @@ class API extends API$1 {
|
|
|
174
161
|
unmarshalListDatabaseBackupsResponse
|
|
175
162
|
);
|
|
176
163
|
/**
|
|
177
|
-
* List your Serverless SQL Database backups. List all Serverless SQL Database
|
|
178
|
-
* backups for a given Scaleway Project or Database. By default, the backups
|
|
179
|
-
* returned in the list are ordered by creation date in descending order,
|
|
180
|
-
* though this can be modified via the order_by field.
|
|
164
|
+
* List your Serverless SQL Database backups. List all Serverless SQL Database backups for a given Scaleway Project or Database. By default, the backups returned in the list are ordered by creation date in descending order, though this can be modified via the order_by field.
|
|
181
165
|
*
|
|
182
166
|
* @param request - The request {@link ListDatabaseBackupsRequest}
|
|
183
167
|
* @returns A Promise of ListDatabaseBackupsResponse
|
|
184
168
|
*/
|
|
185
169
|
listDatabaseBackups = (request) => enrichForPagination("backups", this.pageOfListDatabaseBackups, request);
|
|
186
170
|
/**
|
|
187
|
-
* Export a database backup. Export a database backup providing a download
|
|
188
|
-
* link once the export process is completed. You must provide the `backup_id`
|
|
189
|
-
* parameter.
|
|
171
|
+
* Export a database backup. Export a database backup providing a download link once the export process is completed. You must provide the `backup_id` parameter.
|
|
190
172
|
*
|
|
191
173
|
* @param request - The request {@link ExportDatabaseBackupRequest}
|
|
192
174
|
* @returns A Promise of DatabaseBackup
|
|
@@ -4,192 +4,284 @@ export type DatabaseStatus = 'unknown_status' | 'error' | 'creating' | 'ready' |
|
|
|
4
4
|
export type ListDatabaseBackupsRequestOrderBy = 'created_at_desc' | 'created_at_asc';
|
|
5
5
|
export type ListDatabasesRequestOrderBy = 'created_at_asc' | 'created_at_desc' | 'name_asc' | 'name_desc';
|
|
6
6
|
export interface DatabaseBackup {
|
|
7
|
-
/**
|
|
7
|
+
/**
|
|
8
|
+
* UUID that uniquely identifies a Serverless SQL Database backup.
|
|
9
|
+
*/
|
|
8
10
|
id: string;
|
|
9
11
|
/**
|
|
10
|
-
* Status of the Serverless SQL Database backup. One of `unknown_status` |
|
|
11
|
-
* `error` | `ready` | `locked`.
|
|
12
|
+
* Status of the Serverless SQL Database backup. One of `unknown_status` | `error` | `ready` | `locked`.
|
|
12
13
|
*/
|
|
13
14
|
status: DatabaseBackupStatus;
|
|
14
|
-
/**
|
|
15
|
+
/**
|
|
16
|
+
* The ID of your Scaleway organization.
|
|
17
|
+
*/
|
|
15
18
|
organizationId: string;
|
|
16
|
-
/**
|
|
19
|
+
/**
|
|
20
|
+
* UUID of the Scaleway project.
|
|
21
|
+
*/
|
|
17
22
|
projectId: string;
|
|
18
|
-
/**
|
|
23
|
+
/**
|
|
24
|
+
* UUID of the source Serverless SQL Database the backup is created from.
|
|
25
|
+
*/
|
|
19
26
|
databaseId: string;
|
|
20
|
-
/**
|
|
27
|
+
/**
|
|
28
|
+
* Creation date.
|
|
29
|
+
*/
|
|
21
30
|
createdAt?: Date;
|
|
22
|
-
/**
|
|
31
|
+
/**
|
|
32
|
+
* Expiration date.
|
|
33
|
+
*/
|
|
23
34
|
expiresAt?: Date;
|
|
24
|
-
/**
|
|
35
|
+
/**
|
|
36
|
+
* Size (in bytes) of the database backup file.
|
|
37
|
+
*/
|
|
25
38
|
size?: number;
|
|
26
|
-
/**
|
|
39
|
+
/**
|
|
40
|
+
* Size (in bytes) of the database when backup has been done.
|
|
41
|
+
*/
|
|
27
42
|
dbSize?: number;
|
|
28
|
-
/**
|
|
43
|
+
/**
|
|
44
|
+
* Download URL of the exported database backup.
|
|
45
|
+
*/
|
|
29
46
|
downloadUrl?: string;
|
|
30
|
-
/**
|
|
47
|
+
/**
|
|
48
|
+
* Expiration date of the download URL.
|
|
49
|
+
*/
|
|
31
50
|
downloadUrlExpiresAt?: Date;
|
|
32
|
-
/**
|
|
51
|
+
/**
|
|
52
|
+
* Region of the database backup.
|
|
53
|
+
*/
|
|
33
54
|
region: ScwRegion;
|
|
34
55
|
}
|
|
35
56
|
export interface Database {
|
|
36
|
-
/**
|
|
57
|
+
/**
|
|
58
|
+
* UUID that uniquely identifies your Serverless SQL DB Database.
|
|
59
|
+
*/
|
|
37
60
|
id: string;
|
|
38
|
-
/**
|
|
61
|
+
/**
|
|
62
|
+
* Name of the database.
|
|
63
|
+
*/
|
|
39
64
|
name: string;
|
|
40
65
|
/**
|
|
41
|
-
* Status of the Serverless SQL Ddatabase. One of `unknown_status` | `ready` |
|
|
42
|
-
* `creating` | `deleting` | `error` | `restoring` | `locked`.
|
|
66
|
+
* Status of the Serverless SQL Ddatabase. One of `unknown_status` | `ready` | `creating` | `deleting` | `error` | `restoring` | `locked`.
|
|
43
67
|
*/
|
|
44
68
|
status: DatabaseStatus;
|
|
45
|
-
/**
|
|
69
|
+
/**
|
|
70
|
+
* Endpoint of the database.
|
|
71
|
+
*/
|
|
46
72
|
endpoint: string;
|
|
47
|
-
/**
|
|
73
|
+
/**
|
|
74
|
+
* The ID of your Scaleway organization.
|
|
75
|
+
*/
|
|
48
76
|
organizationId: string;
|
|
49
|
-
/**
|
|
77
|
+
/**
|
|
78
|
+
* Project ID the database belongs to.
|
|
79
|
+
*/
|
|
50
80
|
projectId: string;
|
|
51
|
-
/**
|
|
81
|
+
/**
|
|
82
|
+
* Region of the database.
|
|
83
|
+
*/
|
|
52
84
|
region: ScwRegion;
|
|
53
|
-
/**
|
|
85
|
+
/**
|
|
86
|
+
* Creation date.
|
|
87
|
+
*/
|
|
54
88
|
createdAt?: Date;
|
|
55
|
-
/**
|
|
89
|
+
/**
|
|
90
|
+
* The minimum number of CPU units for your Serverless SQL Database.
|
|
91
|
+
*/
|
|
56
92
|
cpuMin: number;
|
|
57
|
-
/**
|
|
93
|
+
/**
|
|
94
|
+
* The maximum number of CPU units for your Serverless SQL Database.
|
|
95
|
+
*/
|
|
58
96
|
cpuMax: number;
|
|
59
|
-
/**
|
|
97
|
+
/**
|
|
98
|
+
* The current number of CPU units allocated to your Serverless SQL Database.
|
|
99
|
+
*/
|
|
60
100
|
cpuCurrent: number;
|
|
61
|
-
/**
|
|
101
|
+
/**
|
|
102
|
+
* Whether your Serverless SQL Database is running or not.
|
|
103
|
+
*/
|
|
62
104
|
started: boolean;
|
|
63
|
-
/**
|
|
105
|
+
/**
|
|
106
|
+
* The major version of the underlying database engine.
|
|
107
|
+
*/
|
|
64
108
|
engineMajorVersion: number;
|
|
65
109
|
}
|
|
66
110
|
export type CreateDatabaseRequest = {
|
|
67
111
|
/**
|
|
68
|
-
* Region to target. If none is passed will use default region from the
|
|
69
|
-
* config.
|
|
112
|
+
* Region to target. If none is passed will use default region from the config.
|
|
70
113
|
*/
|
|
71
114
|
region?: ScwRegion;
|
|
72
|
-
/**
|
|
115
|
+
/**
|
|
116
|
+
* The ID of your Scaleway project.
|
|
117
|
+
*/
|
|
73
118
|
projectId?: string;
|
|
74
|
-
/**
|
|
119
|
+
/**
|
|
120
|
+
* The name of the Serverless SQL Database to be created.
|
|
121
|
+
*/
|
|
75
122
|
name: string;
|
|
76
|
-
/**
|
|
123
|
+
/**
|
|
124
|
+
* The minimum number of CPU units for your Serverless SQL Database.
|
|
125
|
+
*/
|
|
77
126
|
cpuMin: number;
|
|
78
|
-
/**
|
|
127
|
+
/**
|
|
128
|
+
* The maximum number of CPU units for your Serverless SQL Database.
|
|
129
|
+
*/
|
|
79
130
|
cpuMax: number;
|
|
80
|
-
/**
|
|
131
|
+
/**
|
|
132
|
+
* The ID of the backup to create the database from.
|
|
133
|
+
*/
|
|
81
134
|
fromBackupId?: string;
|
|
82
135
|
};
|
|
83
136
|
export type DeleteDatabaseRequest = {
|
|
84
137
|
/**
|
|
85
|
-
* Region to target. If none is passed will use default region from the
|
|
86
|
-
* config.
|
|
138
|
+
* Region to target. If none is passed will use default region from the config.
|
|
87
139
|
*/
|
|
88
140
|
region?: ScwRegion;
|
|
89
|
-
/**
|
|
141
|
+
/**
|
|
142
|
+
* UUID of the Serverless SQL Database.
|
|
143
|
+
*/
|
|
90
144
|
databaseId: string;
|
|
91
145
|
};
|
|
92
146
|
export type ExportDatabaseBackupRequest = {
|
|
93
147
|
/**
|
|
94
|
-
* Region to target. If none is passed will use default region from the
|
|
95
|
-
* config.
|
|
148
|
+
* Region to target. If none is passed will use default region from the config.
|
|
96
149
|
*/
|
|
97
150
|
region?: ScwRegion;
|
|
98
|
-
/**
|
|
151
|
+
/**
|
|
152
|
+
* UUID of the Serverless SQL Database backup.
|
|
153
|
+
*/
|
|
99
154
|
backupId: string;
|
|
100
155
|
};
|
|
101
156
|
export type GetDatabaseBackupRequest = {
|
|
102
157
|
/**
|
|
103
|
-
* Region to target. If none is passed will use default region from the
|
|
104
|
-
* config.
|
|
158
|
+
* Region to target. If none is passed will use default region from the config.
|
|
105
159
|
*/
|
|
106
160
|
region?: ScwRegion;
|
|
107
|
-
/**
|
|
161
|
+
/**
|
|
162
|
+
* UUID of the Serverless SQL Database backup.
|
|
163
|
+
*/
|
|
108
164
|
backupId: string;
|
|
109
165
|
};
|
|
110
166
|
export type GetDatabaseRequest = {
|
|
111
167
|
/**
|
|
112
|
-
* Region to target. If none is passed will use default region from the
|
|
113
|
-
* config.
|
|
168
|
+
* Region to target. If none is passed will use default region from the config.
|
|
114
169
|
*/
|
|
115
170
|
region?: ScwRegion;
|
|
116
|
-
/**
|
|
171
|
+
/**
|
|
172
|
+
* UUID of the Serverless SQL DB database.
|
|
173
|
+
*/
|
|
117
174
|
databaseId: string;
|
|
118
175
|
};
|
|
119
176
|
export type ListDatabaseBackupsRequest = {
|
|
120
177
|
/**
|
|
121
|
-
* Region to target. If none is passed will use default region from the
|
|
122
|
-
* config.
|
|
178
|
+
* Region to target. If none is passed will use default region from the config.
|
|
123
179
|
*/
|
|
124
180
|
region?: ScwRegion;
|
|
125
|
-
/**
|
|
181
|
+
/**
|
|
182
|
+
* Filter by the UUID of the Scaleway organization.
|
|
183
|
+
*/
|
|
126
184
|
organizationId?: string;
|
|
127
|
-
/**
|
|
185
|
+
/**
|
|
186
|
+
* Filter by the UUID of the Scaleway project.
|
|
187
|
+
*/
|
|
128
188
|
projectId?: string;
|
|
129
|
-
/**
|
|
189
|
+
/**
|
|
190
|
+
* Filter by the UUID of the Serverless SQL Database.
|
|
191
|
+
*/
|
|
130
192
|
databaseId: string;
|
|
131
|
-
/**
|
|
193
|
+
/**
|
|
194
|
+
* Page number.
|
|
195
|
+
*/
|
|
132
196
|
page?: number;
|
|
133
|
-
/**
|
|
197
|
+
/**
|
|
198
|
+
* Page size.
|
|
199
|
+
*/
|
|
134
200
|
pageSize?: number;
|
|
135
|
-
/**
|
|
201
|
+
/**
|
|
202
|
+
* Sorting criteria. One of `created_at_asc`, `created_at_desc`.
|
|
203
|
+
*/
|
|
136
204
|
orderBy?: ListDatabaseBackupsRequestOrderBy;
|
|
137
205
|
};
|
|
138
206
|
export interface ListDatabaseBackupsResponse {
|
|
139
|
-
/**
|
|
207
|
+
/**
|
|
208
|
+
* List of the backups.
|
|
209
|
+
*/
|
|
140
210
|
backups: DatabaseBackup[];
|
|
141
|
-
/**
|
|
211
|
+
/**
|
|
212
|
+
* Length of the backups list.
|
|
213
|
+
*/
|
|
142
214
|
totalCount: number;
|
|
143
215
|
}
|
|
144
216
|
export type ListDatabasesRequest = {
|
|
145
217
|
/**
|
|
146
|
-
* Region to target. If none is passed will use default region from the
|
|
147
|
-
* config.
|
|
218
|
+
* Region to target. If none is passed will use default region from the config.
|
|
148
219
|
*/
|
|
149
220
|
region?: ScwRegion;
|
|
150
|
-
/**
|
|
221
|
+
/**
|
|
222
|
+
* Filter by the UUID of the Scaleway organization.
|
|
223
|
+
*/
|
|
151
224
|
organizationId?: string;
|
|
152
|
-
/**
|
|
225
|
+
/**
|
|
226
|
+
* UUID of the Scaleway project.
|
|
227
|
+
*/
|
|
153
228
|
projectId?: string;
|
|
154
|
-
/**
|
|
229
|
+
/**
|
|
230
|
+
* Page number.
|
|
231
|
+
*/
|
|
155
232
|
page?: number;
|
|
156
|
-
/**
|
|
233
|
+
/**
|
|
234
|
+
* Page size.
|
|
235
|
+
*/
|
|
157
236
|
pageSize?: number;
|
|
158
|
-
/**
|
|
237
|
+
/**
|
|
238
|
+
* Filter by the name of the database.
|
|
239
|
+
*/
|
|
159
240
|
name?: string;
|
|
160
241
|
/**
|
|
161
|
-
* Sorting criteria. One of `created_at_asc`, `created_at_desc`, `name_asc`,
|
|
162
|
-
* `name_desc`.
|
|
242
|
+
* Sorting criteria. One of `created_at_asc`, `created_at_desc`, `name_asc`, `name_desc`.
|
|
163
243
|
*/
|
|
164
244
|
orderBy?: ListDatabasesRequestOrderBy;
|
|
165
245
|
};
|
|
166
246
|
export interface ListDatabasesResponse {
|
|
167
|
-
/**
|
|
247
|
+
/**
|
|
248
|
+
* List of the databases.
|
|
249
|
+
*/
|
|
168
250
|
databases: Database[];
|
|
169
|
-
/**
|
|
251
|
+
/**
|
|
252
|
+
* Total count of Serverless SQL Databases.
|
|
253
|
+
*/
|
|
170
254
|
totalCount: number;
|
|
171
255
|
}
|
|
172
256
|
export type RestoreDatabaseFromBackupRequest = {
|
|
173
257
|
/**
|
|
174
|
-
* Region to target. If none is passed will use default region from the
|
|
175
|
-
* config.
|
|
258
|
+
* Region to target. If none is passed will use default region from the config.
|
|
176
259
|
*/
|
|
177
260
|
region?: ScwRegion;
|
|
178
|
-
/**
|
|
261
|
+
/**
|
|
262
|
+
* UUID of the Serverless SQL Database.
|
|
263
|
+
*/
|
|
179
264
|
databaseId: string;
|
|
180
|
-
/**
|
|
265
|
+
/**
|
|
266
|
+
* UUID of the Serverless SQL Database backup to restore.
|
|
267
|
+
*/
|
|
181
268
|
backupId: string;
|
|
182
269
|
};
|
|
183
270
|
export type UpdateDatabaseRequest = {
|
|
184
271
|
/**
|
|
185
|
-
* Region to target. If none is passed will use default region from the
|
|
186
|
-
* config.
|
|
272
|
+
* Region to target. If none is passed will use default region from the config.
|
|
187
273
|
*/
|
|
188
274
|
region?: ScwRegion;
|
|
189
|
-
/**
|
|
275
|
+
/**
|
|
276
|
+
* UUID of the Serverless SQL Database.
|
|
277
|
+
*/
|
|
190
278
|
databaseId: string;
|
|
191
|
-
/**
|
|
279
|
+
/**
|
|
280
|
+
* The minimum number of CPU units for your Serverless SQL Database.
|
|
281
|
+
*/
|
|
192
282
|
cpuMin?: number;
|
|
193
|
-
/**
|
|
283
|
+
/**
|
|
284
|
+
* The maximum number of CPU units for your Serverless SQL Database.
|
|
285
|
+
*/
|
|
194
286
|
cpuMax?: number;
|
|
195
287
|
};
|