@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
|
@@ -3,17 +3,15 @@ import type { Region as ScwRegion, WaitForOptions } from '@scaleway/sdk-client';
|
|
|
3
3
|
import type { AddInstanceACLRulesRequest, AddInstanceACLRulesResponse, AddInstanceSettingsRequest, AddInstanceSettingsResponse, ApplyInstanceMaintenanceRequest, CloneInstanceRequest, CreateDatabaseBackupRequest, CreateDatabaseRequest, CreateEndpointRequest, CreateInstanceFromSnapshotRequest, CreateInstanceRequest, CreateReadReplicaEndpointRequest, CreateReadReplicaRequest, CreateSnapshotRequest, CreateUserRequest, Database, DatabaseBackup, DeleteDatabaseBackupRequest, DeleteDatabaseRequest, DeleteEndpointRequest, DeleteInstanceACLRulesRequest, DeleteInstanceACLRulesResponse, DeleteInstanceRequest, DeleteInstanceSettingsRequest, DeleteInstanceSettingsResponse, DeleteReadReplicaRequest, DeleteSnapshotRequest, DeleteUserRequest, Endpoint, ExportDatabaseBackupRequest, GetDatabaseBackupRequest, GetEndpointRequest, GetInstanceCertificateRequest, GetInstanceLogRequest, GetInstanceMetricsRequest, GetInstanceRequest, GetReadReplicaRequest, GetSnapshotRequest, Instance, InstanceLog, InstanceMetrics, ListDatabaseBackupsRequest, ListDatabaseBackupsResponse, ListDatabaseEnginesRequest, ListDatabaseEnginesResponse, ListDatabasesRequest, ListDatabasesResponse, ListInstanceACLRulesRequest, ListInstanceACLRulesResponse, ListInstanceLogsDetailsRequest, ListInstanceLogsDetailsResponse, ListInstanceLogsRequest, ListInstanceLogsResponse, ListInstancesRequest, ListInstancesResponse, ListNodeTypesRequest, ListNodeTypesResponse, ListPrivilegesRequest, ListPrivilegesResponse, ListSnapshotsRequest, ListSnapshotsResponse, ListUsersRequest, ListUsersResponse, Maintenance, MigrateEndpointRequest, PrepareInstanceLogsRequest, PrepareInstanceLogsResponse, Privilege, PromoteReadReplicaRequest, PurgeInstanceLogsRequest, ReadReplica, RenewInstanceCertificateRequest, ResetReadReplicaRequest, RestartInstanceRequest, RestoreDatabaseBackupRequest, SetInstanceACLRulesRequest, SetInstanceACLRulesResponse, SetInstanceSettingsRequest, SetInstanceSettingsResponse, SetPrivilegeRequest, Snapshot, UpdateDatabaseBackupRequest, UpdateInstanceRequest, UpdateSnapshotRequest, UpdateUserRequest, UpgradeInstanceRequest, User } from './types.gen';
|
|
4
4
|
/**
|
|
5
5
|
* Managed Database for PostgreSQL and MySQL API.
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
* MySQL.
|
|
6
|
+
|
|
7
|
+
This API allows you to manage your Managed Databases for PostgreSQL and MySQL.
|
|
9
8
|
*/
|
|
10
9
|
export declare class API extends ParentAPI {
|
|
11
10
|
/** Lists the available regions of the API. */
|
|
12
11
|
static readonly LOCALITIES: ScwRegion[];
|
|
13
12
|
protected pageOfListDatabaseEngines: (request?: Readonly<ListDatabaseEnginesRequest>) => Promise<ListDatabaseEnginesResponse>;
|
|
14
13
|
/**
|
|
15
|
-
* List available database engines. List the PostgreSQL and MySQL database
|
|
16
|
-
* engines available at Scaleway.
|
|
14
|
+
* List available database engines. List the PostgreSQL and MySQL database engines available at Scaleway.
|
|
17
15
|
*
|
|
18
16
|
* @param request - The request {@link ListDatabaseEnginesRequest}
|
|
19
17
|
* @returns A Promise of ListDatabaseEnginesResponse
|
|
@@ -24,9 +22,7 @@ export declare class API extends ParentAPI {
|
|
|
24
22
|
};
|
|
25
23
|
protected pageOfListNodeTypes: (request: Readonly<ListNodeTypesRequest>) => Promise<ListNodeTypesResponse>;
|
|
26
24
|
/**
|
|
27
|
-
* List available node types. List all available node types. By default, the
|
|
28
|
-
* node types returned in the list are ordered by creation date in ascending
|
|
29
|
-
* order, though this can be modified via the `order_by` field.
|
|
25
|
+
* 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.
|
|
30
26
|
*
|
|
31
27
|
* @param request - The request {@link ListNodeTypesRequest}
|
|
32
28
|
* @returns A Promise of ListNodeTypesResponse
|
|
@@ -37,10 +33,7 @@ export declare class API extends ParentAPI {
|
|
|
37
33
|
};
|
|
38
34
|
protected pageOfListDatabaseBackups: (request?: Readonly<ListDatabaseBackupsRequest>) => Promise<ListDatabaseBackupsResponse>;
|
|
39
35
|
/**
|
|
40
|
-
* List database backups. List all backups in a specified region, for a given
|
|
41
|
-
* Scaleway Organization or Scaleway Project. By default, the backups listed
|
|
42
|
-
* are ordered by creation date in ascending order. This can be modified via
|
|
43
|
-
* the `order_by` field.
|
|
36
|
+
* 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.
|
|
44
37
|
*
|
|
45
38
|
* @param request - The request {@link ListDatabaseBackupsRequest}
|
|
46
39
|
* @returns A Promise of ListDatabaseBackupsResponse
|
|
@@ -50,17 +43,14 @@ export declare class API extends ParentAPI {
|
|
|
50
43
|
[Symbol.asyncIterator]: () => AsyncGenerator<DatabaseBackup[], void, void>;
|
|
51
44
|
};
|
|
52
45
|
/**
|
|
53
|
-
* Create a database backup. Create a new backup. You must set the
|
|
54
|
-
* `instance_id`, `database_name`, `name` and `expires_at` parameters.
|
|
46
|
+
* Create a database backup. Create a new backup. You must set the `instance_id`, `database_name`, `name` and `expires_at` parameters.
|
|
55
47
|
*
|
|
56
48
|
* @param request - The request {@link CreateDatabaseBackupRequest}
|
|
57
49
|
* @returns A Promise of DatabaseBackup
|
|
58
50
|
*/
|
|
59
51
|
createDatabaseBackup: (request: Readonly<CreateDatabaseBackupRequest>) => Promise<DatabaseBackup>;
|
|
60
52
|
/**
|
|
61
|
-
* Get a database backup. Retrieve information about a given backup, specified
|
|
62
|
-
* by its database backup ID and region. Full details about the backup, like
|
|
63
|
-
* size, URL and expiration date, are returned in the response.
|
|
53
|
+
* 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.
|
|
64
54
|
*
|
|
65
55
|
* @param request - The request {@link GetDatabaseBackupRequest}
|
|
66
56
|
* @returns A Promise of DatabaseBackup
|
|
@@ -75,45 +65,35 @@ export declare class API extends ParentAPI {
|
|
|
75
65
|
*/
|
|
76
66
|
waitForDatabaseBackup: (request: Readonly<GetDatabaseBackupRequest>, options?: Readonly<WaitForOptions<DatabaseBackup>>) => Promise<DatabaseBackup>;
|
|
77
67
|
/**
|
|
78
|
-
* Update a database backup. Update the parameters of a backup, including name
|
|
79
|
-
* and expiration date.
|
|
68
|
+
* Update a database backup. Update the parameters of a backup, including name and expiration date.
|
|
80
69
|
*
|
|
81
70
|
* @param request - The request {@link UpdateDatabaseBackupRequest}
|
|
82
71
|
* @returns A Promise of DatabaseBackup
|
|
83
72
|
*/
|
|
84
73
|
updateDatabaseBackup: (request: Readonly<UpdateDatabaseBackupRequest>) => Promise<DatabaseBackup>;
|
|
85
74
|
/**
|
|
86
|
-
* Delete a database backup. Delete a backup, specified by its database backup
|
|
87
|
-
* ID and region. Deleting a backup is permanent, and cannot be undone.
|
|
75
|
+
* Delete a database backup. Delete a backup, specified by its database backup ID and region. Deleting a backup is permanent, and cannot be undone.
|
|
88
76
|
*
|
|
89
77
|
* @param request - The request {@link DeleteDatabaseBackupRequest}
|
|
90
78
|
* @returns A Promise of DatabaseBackup
|
|
91
79
|
*/
|
|
92
80
|
deleteDatabaseBackup: (request: Readonly<DeleteDatabaseBackupRequest>) => Promise<DatabaseBackup>;
|
|
93
81
|
/**
|
|
94
|
-
* Restore a database backup. Launch the process of restoring database backup.
|
|
95
|
-
* You must specify the `instance_id` of the Database Instance of destination,
|
|
96
|
-
* where the backup will be restored. Note that large database backups can
|
|
97
|
-
* take up to several hours to restore.
|
|
82
|
+
* 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.
|
|
98
83
|
*
|
|
99
84
|
* @param request - The request {@link RestoreDatabaseBackupRequest}
|
|
100
85
|
* @returns A Promise of DatabaseBackup
|
|
101
86
|
*/
|
|
102
87
|
restoreDatabaseBackup: (request: Readonly<RestoreDatabaseBackupRequest>) => Promise<DatabaseBackup>;
|
|
103
88
|
/**
|
|
104
|
-
* Export a database backup. Export a backup, specified by the
|
|
105
|
-
* `database_backup_id` and the `region` parameters. The download URL is
|
|
106
|
-
* returned in the response.
|
|
89
|
+
* 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.
|
|
107
90
|
*
|
|
108
91
|
* @param request - The request {@link ExportDatabaseBackupRequest}
|
|
109
92
|
* @returns A Promise of DatabaseBackup
|
|
110
93
|
*/
|
|
111
94
|
exportDatabaseBackup: (request: Readonly<ExportDatabaseBackupRequest>) => Promise<DatabaseBackup>;
|
|
112
95
|
/**
|
|
113
|
-
* Upgrade a Database Instance. Upgrade your current Database Instance
|
|
114
|
-
* specifications like node type, high availability, volume, or the database
|
|
115
|
-
* engine version. Note that upon upgrade the `enable_ha` parameter can only
|
|
116
|
-
* be set to `true`.
|
|
96
|
+
* 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`.
|
|
117
97
|
*
|
|
118
98
|
* @param request - The request {@link UpgradeInstanceRequest}
|
|
119
99
|
* @returns A Promise of Instance
|
|
@@ -121,14 +101,7 @@ export declare class API extends ParentAPI {
|
|
|
121
101
|
upgradeInstance: (request: Readonly<UpgradeInstanceRequest>) => Promise<Instance>;
|
|
122
102
|
protected pageOfListInstances: (request?: Readonly<ListInstancesRequest>) => Promise<ListInstancesResponse>;
|
|
123
103
|
/**
|
|
124
|
-
* List Database Instances. List all Database Instances in the specified
|
|
125
|
-
* region, for a given Scaleway Organization or Scaleway Project. By default,
|
|
126
|
-
* the Database Instances returned in the list are ordered by creation date in
|
|
127
|
-
* ascending order, though this can be modified via the order_by field. You
|
|
128
|
-
* can define additional parameters for your query, such as `tags` and `name`.
|
|
129
|
-
* For the `name` parameter, the value you include will be checked against the
|
|
130
|
-
* whole name string to see if it includes the string you put in the
|
|
131
|
-
* parameter.
|
|
104
|
+
* 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.
|
|
132
105
|
*
|
|
133
106
|
* @param request - The request {@link ListInstancesRequest}
|
|
134
107
|
* @returns A Promise of ListInstancesResponse
|
|
@@ -138,10 +111,7 @@ export declare class API extends ParentAPI {
|
|
|
138
111
|
[Symbol.asyncIterator]: () => AsyncGenerator<Instance[], void, void>;
|
|
139
112
|
};
|
|
140
113
|
/**
|
|
141
|
-
* Get a Database Instance. Retrieve information about a given Database
|
|
142
|
-
* Instance, specified by the `region` and `instance_id` parameters. Its full
|
|
143
|
-
* details, including name, status, IP address and port, are returned in the
|
|
144
|
-
* response object.
|
|
114
|
+
* 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.
|
|
145
115
|
*
|
|
146
116
|
* @param request - The request {@link GetInstanceRequest}
|
|
147
117
|
* @returns A Promise of Instance
|
|
@@ -156,93 +126,69 @@ export declare class API extends ParentAPI {
|
|
|
156
126
|
*/
|
|
157
127
|
waitForInstance: (request: Readonly<GetInstanceRequest>, options?: Readonly<WaitForOptions<Instance>>) => Promise<Instance>;
|
|
158
128
|
/**
|
|
159
|
-
* Create a Database Instance. Create a new Database Instance. You must set
|
|
160
|
-
* the `engine`, `user_name`, `password` and `node_type` parameters.
|
|
161
|
-
* Optionally, you can specify the volume type and size.
|
|
129
|
+
* 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.
|
|
162
130
|
*
|
|
163
131
|
* @param request - The request {@link CreateInstanceRequest}
|
|
164
132
|
* @returns A Promise of Instance
|
|
165
133
|
*/
|
|
166
134
|
createInstance: (request: Readonly<CreateInstanceRequest>) => Promise<Instance>;
|
|
167
135
|
/**
|
|
168
|
-
* Update a Database Instance. Update the parameters of a Database Instance,
|
|
169
|
-
* including name, tags and backup schedule details.
|
|
136
|
+
* Update a Database Instance. Update the parameters of a Database Instance, including name, tags and backup schedule details.
|
|
170
137
|
*
|
|
171
138
|
* @param request - The request {@link UpdateInstanceRequest}
|
|
172
139
|
* @returns A Promise of Instance
|
|
173
140
|
*/
|
|
174
141
|
updateInstance: (request: Readonly<UpdateInstanceRequest>) => Promise<Instance>;
|
|
175
142
|
/**
|
|
176
|
-
* Delete a Database Instance. Delete a given Database Instance, specified by
|
|
177
|
-
* the `region` and `instance_id` parameters. Deleting a Database Instance is
|
|
178
|
-
* permanent, and cannot be undone. Note that upon deletion all your data will
|
|
179
|
-
* be lost.
|
|
143
|
+
* 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.
|
|
180
144
|
*
|
|
181
145
|
* @param request - The request {@link DeleteInstanceRequest}
|
|
182
146
|
* @returns A Promise of Instance
|
|
183
147
|
*/
|
|
184
148
|
deleteInstance: (request: Readonly<DeleteInstanceRequest>) => Promise<Instance>;
|
|
185
149
|
/**
|
|
186
|
-
* Clone a Database Instance. Clone a given Database Instance, specified by
|
|
187
|
-
* the `region` and `instance_id` parameters. The clone feature allows you to
|
|
188
|
-
* create a new Database Instance from an existing one. The clone includes all
|
|
189
|
-
* existing databases, users and permissions. You can create a clone on a
|
|
190
|
-
* Database Instance bigger than your current one.
|
|
150
|
+
* 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.
|
|
191
151
|
*
|
|
192
152
|
* @param request - The request {@link CloneInstanceRequest}
|
|
193
153
|
* @returns A Promise of Instance
|
|
194
154
|
*/
|
|
195
155
|
cloneInstance: (request: Readonly<CloneInstanceRequest>) => Promise<Instance>;
|
|
196
156
|
/**
|
|
197
|
-
* Restart Database Instance. Restart a given Database Instance, specified by
|
|
198
|
-
* the `region` and `instance_id` parameters. The status of the Database
|
|
199
|
-
* Instance returned in the response.
|
|
157
|
+
* 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.
|
|
200
158
|
*
|
|
201
159
|
* @param request - The request {@link RestartInstanceRequest}
|
|
202
160
|
* @returns A Promise of Instance
|
|
203
161
|
*/
|
|
204
162
|
restartInstance: (request: Readonly<RestartInstanceRequest>) => Promise<Instance>;
|
|
205
163
|
/**
|
|
206
|
-
* Get the TLS certificate of a Database Instance. Retrieve information about
|
|
207
|
-
* the TLS certificate of a given Database Instance. Details like name and
|
|
208
|
-
* content are returned in the response.
|
|
164
|
+
* 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.
|
|
209
165
|
*
|
|
210
166
|
* @param request - The request {@link GetInstanceCertificateRequest}
|
|
211
167
|
* @returns A Promise of Blob
|
|
212
168
|
*/
|
|
213
169
|
getInstanceCertificate: (request: Readonly<GetInstanceCertificateRequest>) => Promise<Blob>;
|
|
214
170
|
/**
|
|
215
|
-
* Renew the TLS certificate of a Database Instance. Renew a TLS for a
|
|
216
|
-
* Database Instance. Renewing a certificate means that you will not be able
|
|
217
|
-
* to connect to your Database Instance using the previous certificate. You
|
|
218
|
-
* will also need to download and update the new certificate for all database
|
|
219
|
-
* clients.
|
|
171
|
+
* 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.
|
|
220
172
|
*
|
|
221
173
|
* @param request - The request {@link RenewInstanceCertificateRequest}
|
|
222
174
|
*/
|
|
223
175
|
renewInstanceCertificate: (request: Readonly<RenewInstanceCertificateRequest>) => Promise<void>;
|
|
224
176
|
/**
|
|
225
|
-
* Get Database Instance metrics. Retrieve the time series metrics of a given
|
|
226
|
-
* Database Instance. You can define the period from which to retrieve metrics
|
|
227
|
-
* by specifying the `start_date` and `end_date`.
|
|
177
|
+
* 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`.
|
|
228
178
|
*
|
|
229
179
|
* @param request - The request {@link GetInstanceMetricsRequest}
|
|
230
180
|
* @returns A Promise of InstanceMetrics
|
|
231
181
|
*/
|
|
232
182
|
getInstanceMetrics: (request: Readonly<GetInstanceMetricsRequest>) => Promise<InstanceMetrics>;
|
|
233
183
|
/**
|
|
234
|
-
* Create a Read Replica. Create a new Read Replica of a Database Instance.
|
|
235
|
-
* You must specify the `region` and the `instance_id`. You can only create a
|
|
236
|
-
* maximum of 3 Read Replicas per Database Instance.
|
|
184
|
+
* 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.
|
|
237
185
|
*
|
|
238
186
|
* @param request - The request {@link CreateReadReplicaRequest}
|
|
239
187
|
* @returns A Promise of ReadReplica
|
|
240
188
|
*/
|
|
241
189
|
createReadReplica: (request: Readonly<CreateReadReplicaRequest>) => Promise<ReadReplica>;
|
|
242
190
|
/**
|
|
243
|
-
* Get a Read Replica. Retrieve information about a Database Instance Read
|
|
244
|
-
* Replica. Full details about the Read Replica, like `endpoints`, `status`
|
|
245
|
-
* and `region` are returned in the response.
|
|
191
|
+
* 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.
|
|
246
192
|
*
|
|
247
193
|
* @param request - The request {@link GetReadReplicaRequest}
|
|
248
194
|
* @returns A Promise of ReadReplica
|
|
@@ -257,69 +203,50 @@ export declare class API extends ParentAPI {
|
|
|
257
203
|
*/
|
|
258
204
|
waitForReadReplica: (request: Readonly<GetReadReplicaRequest>, options?: Readonly<WaitForOptions<ReadReplica>>) => Promise<ReadReplica>;
|
|
259
205
|
/**
|
|
260
|
-
* Delete a Read Replica. Delete a Read Replica of a Database Instance. You
|
|
261
|
-
* must specify the `region` and `read_replica_id` parameters of the Read
|
|
262
|
-
* Replica you want to delete.
|
|
206
|
+
* 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.
|
|
263
207
|
*
|
|
264
208
|
* @param request - The request {@link DeleteReadReplicaRequest}
|
|
265
209
|
* @returns A Promise of ReadReplica
|
|
266
210
|
*/
|
|
267
211
|
deleteReadReplica: (request: Readonly<DeleteReadReplicaRequest>) => Promise<ReadReplica>;
|
|
268
212
|
/**
|
|
269
|
-
* Resync a Read Replica. When you resync a Read Replica, first it is reset,
|
|
270
|
-
|
|
271
|
-
* remains unavailable during the resync process. The duration of this process
|
|
272
|
-
* is proportional to the size of your Database Instance. The configured
|
|
273
|
-
* endpoints do not change.
|
|
213
|
+
* 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.
|
|
214
|
+
The configured endpoints do not change.
|
|
274
215
|
*
|
|
275
216
|
* @param request - The request {@link ResetReadReplicaRequest}
|
|
276
217
|
* @returns A Promise of ReadReplica
|
|
277
218
|
*/
|
|
278
219
|
resetReadReplica: (request: Readonly<ResetReadReplicaRequest>) => Promise<ReadReplica>;
|
|
279
220
|
/**
|
|
280
|
-
* Promote a Read Replica. Promote a Read Replica to Database Instance
|
|
281
|
-
* automatically.
|
|
221
|
+
* Promote a Read Replica. Promote a Read Replica to Database Instance automatically.
|
|
282
222
|
*
|
|
283
223
|
* @param request - The request {@link PromoteReadReplicaRequest}
|
|
284
224
|
* @returns A Promise of Instance
|
|
285
225
|
*/
|
|
286
226
|
promoteReadReplica: (request: Readonly<PromoteReadReplicaRequest>) => Promise<Instance>;
|
|
287
227
|
/**
|
|
288
|
-
* Create an endpoint for a Read Replica. Create a new endpoint for a Read
|
|
289
|
-
* Replica. Read Replicas can have at most one direct access and one Private
|
|
290
|
-
* Network endpoint.
|
|
228
|
+
* 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.
|
|
291
229
|
*
|
|
292
230
|
* @param request - The request {@link CreateReadReplicaEndpointRequest}
|
|
293
231
|
* @returns A Promise of ReadReplica
|
|
294
232
|
*/
|
|
295
233
|
createReadReplicaEndpoint: (request: Readonly<CreateReadReplicaEndpointRequest>) => Promise<ReadReplica>;
|
|
296
234
|
/**
|
|
297
|
-
* Prepare logs of a Database Instance. Prepare your Database Instance logs.
|
|
298
|
-
* You can define the `start_date` and `end_date` parameters for your query.
|
|
299
|
-
* The download URL is returned in the response. Logs are recorded from 00h00
|
|
300
|
-
* to 23h59 and then aggregated in a `.log` file once a day. Therefore, even
|
|
301
|
-
* if you specify a timeframe from which you want to get the logs, you will
|
|
302
|
-
* receive logs from the full 24 hours.
|
|
235
|
+
* 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.
|
|
303
236
|
*
|
|
304
237
|
* @param request - The request {@link PrepareInstanceLogsRequest}
|
|
305
238
|
* @returns A Promise of PrepareInstanceLogsResponse
|
|
306
239
|
*/
|
|
307
240
|
prepareInstanceLogs: (request: Readonly<PrepareInstanceLogsRequest>) => Promise<PrepareInstanceLogsResponse>;
|
|
308
241
|
/**
|
|
309
|
-
* List available logs of a Database Instance. List the available logs of a
|
|
310
|
-
* Database Instance. By default, the logs returned in the list are ordered by
|
|
311
|
-
* creation date in ascending order, though this can be modified via the
|
|
312
|
-
* order_by field.
|
|
242
|
+
* 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.
|
|
313
243
|
*
|
|
314
244
|
* @param request - The request {@link ListInstanceLogsRequest}
|
|
315
245
|
* @returns A Promise of ListInstanceLogsResponse
|
|
316
246
|
*/
|
|
317
247
|
listInstanceLogs: (request: Readonly<ListInstanceLogsRequest>) => Promise<ListInstanceLogsResponse>;
|
|
318
248
|
/**
|
|
319
|
-
* Get given logs of a Database Instance. Retrieve information about the logs
|
|
320
|
-
* of a Database Instance. Specify the `instance_log_id` and `region` in your
|
|
321
|
-
* request to get information such as `download_url`, `status`, `expires_at`
|
|
322
|
-
* and `created_at` about your logs in the response.
|
|
249
|
+
* 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.
|
|
323
250
|
*
|
|
324
251
|
* @param request - The request {@link GetInstanceLogRequest}
|
|
325
252
|
* @returns A Promise of InstanceLog
|
|
@@ -334,44 +261,34 @@ export declare class API extends ParentAPI {
|
|
|
334
261
|
*/
|
|
335
262
|
waitForInstanceLog: (request: Readonly<GetInstanceLogRequest>, options?: Readonly<WaitForOptions<InstanceLog>>) => Promise<InstanceLog>;
|
|
336
263
|
/**
|
|
337
|
-
* Purge remote Database Instance logs. Purge a given remote log from a
|
|
338
|
-
* Database Instance. You can specify the `log_name` of the log you wish to
|
|
339
|
-
* clean from your Database Instance.
|
|
264
|
+
* 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.
|
|
340
265
|
*
|
|
341
266
|
* @param request - The request {@link PurgeInstanceLogsRequest}
|
|
342
267
|
*/
|
|
343
268
|
purgeInstanceLogs: (request: Readonly<PurgeInstanceLogsRequest>) => Promise<void>;
|
|
344
269
|
/**
|
|
345
|
-
* List remote Database Instance logs details. List remote log details. By
|
|
346
|
-
* default, the details returned in the list are ordered by creation date in
|
|
347
|
-
* ascending order, though this can be modified via the order_by field.
|
|
270
|
+
* 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.
|
|
348
271
|
*
|
|
349
272
|
* @param request - The request {@link ListInstanceLogsDetailsRequest}
|
|
350
273
|
* @returns A Promise of ListInstanceLogsDetailsResponse
|
|
351
274
|
*/
|
|
352
275
|
listInstanceLogsDetails: (request: Readonly<ListInstanceLogsDetailsRequest>) => Promise<ListInstanceLogsDetailsResponse>;
|
|
353
276
|
/**
|
|
354
|
-
* Add Database Instance advanced settings. Add an advanced setting to a
|
|
355
|
-
* Database Instance. You must set the `name` and the `value` of each
|
|
356
|
-
* setting.
|
|
277
|
+
* Add Database Instance advanced settings. Add an advanced setting to a Database Instance. You must set the `name` and the `value` of each setting.
|
|
357
278
|
*
|
|
358
279
|
* @param request - The request {@link AddInstanceSettingsRequest}
|
|
359
280
|
* @returns A Promise of AddInstanceSettingsResponse
|
|
360
281
|
*/
|
|
361
282
|
addInstanceSettings: (request: Readonly<AddInstanceSettingsRequest>) => Promise<AddInstanceSettingsResponse>;
|
|
362
283
|
/**
|
|
363
|
-
* Delete Database Instance advanced settings. Delete an advanced setting in a
|
|
364
|
-
* Database Instance. You must specify the names of the settings you want to
|
|
365
|
-
* delete in the request.
|
|
284
|
+
* 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.
|
|
366
285
|
*
|
|
367
286
|
* @param request - The request {@link DeleteInstanceSettingsRequest}
|
|
368
287
|
* @returns A Promise of DeleteInstanceSettingsResponse
|
|
369
288
|
*/
|
|
370
289
|
deleteInstanceSettings: (request: Readonly<DeleteInstanceSettingsRequest>) => Promise<DeleteInstanceSettingsResponse>;
|
|
371
290
|
/**
|
|
372
|
-
* Set Database Instance advanced settings. Update an advanced setting for a
|
|
373
|
-
* Database Instance. Settings added upon database engine initalization can
|
|
374
|
-
* only be defined once, and cannot, therefore, be updated.
|
|
291
|
+
* 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.
|
|
375
292
|
*
|
|
376
293
|
* @param request - The request {@link SetInstanceSettingsRequest}
|
|
377
294
|
* @returns A Promise of SetInstanceSettingsResponse
|
|
@@ -379,10 +296,7 @@ export declare class API extends ParentAPI {
|
|
|
379
296
|
setInstanceSettings: (request: Readonly<SetInstanceSettingsRequest>) => Promise<SetInstanceSettingsResponse>;
|
|
380
297
|
protected pageOfListInstanceACLRules: (request: Readonly<ListInstanceACLRulesRequest>) => Promise<ListInstanceACLRulesResponse>;
|
|
381
298
|
/**
|
|
382
|
-
* List ACL rules of a Database Instance. List the ACL rules for a given
|
|
383
|
-
* Database Instance. The response is an array of ACL objects, each one
|
|
384
|
-
* representing an ACL that denies, allows or redirects traffic based on
|
|
385
|
-
* certain conditions.
|
|
299
|
+
* 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.
|
|
386
300
|
*
|
|
387
301
|
* @param request - The request {@link ListInstanceACLRulesRequest}
|
|
388
302
|
* @returns A Promise of ListInstanceACLRulesResponse
|
|
@@ -392,24 +306,21 @@ export declare class API extends ParentAPI {
|
|
|
392
306
|
[Symbol.asyncIterator]: () => AsyncGenerator<import("./types.gen").ACLRule[], void, void>;
|
|
393
307
|
};
|
|
394
308
|
/**
|
|
395
|
-
* Add an ACL rule to a Database Instance. Add an additional ACL rule to a
|
|
396
|
-
* Database Instance.
|
|
309
|
+
* Add an ACL rule to a Database Instance. Add an additional ACL rule to a Database Instance.
|
|
397
310
|
*
|
|
398
311
|
* @param request - The request {@link AddInstanceACLRulesRequest}
|
|
399
312
|
* @returns A Promise of AddInstanceACLRulesResponse
|
|
400
313
|
*/
|
|
401
314
|
addInstanceACLRules: (request: Readonly<AddInstanceACLRulesRequest>) => Promise<AddInstanceACLRulesResponse>;
|
|
402
315
|
/**
|
|
403
|
-
* Set ACL rules for a Database Instance. Replace all the ACL rules of a
|
|
404
|
-
* Database Instance.
|
|
316
|
+
* Set ACL rules for a Database Instance. Replace all the ACL rules of a Database Instance.
|
|
405
317
|
*
|
|
406
318
|
* @param request - The request {@link SetInstanceACLRulesRequest}
|
|
407
319
|
* @returns A Promise of SetInstanceACLRulesResponse
|
|
408
320
|
*/
|
|
409
321
|
setInstanceACLRules: (request: Readonly<SetInstanceACLRulesRequest>) => Promise<SetInstanceACLRulesResponse>;
|
|
410
322
|
/**
|
|
411
|
-
* Delete ACL rules of a Database Instance. Delete one or more ACL rules of a
|
|
412
|
-
* Database Instance.
|
|
323
|
+
* Delete ACL rules of a Database Instance. Delete one or more ACL rules of a Database Instance.
|
|
413
324
|
*
|
|
414
325
|
* @param request - The request {@link DeleteInstanceACLRulesRequest}
|
|
415
326
|
* @returns A Promise of DeleteInstanceACLRulesResponse
|
|
@@ -417,10 +328,7 @@ export declare class API extends ParentAPI {
|
|
|
417
328
|
deleteInstanceACLRules: (request: Readonly<DeleteInstanceACLRulesRequest>) => Promise<DeleteInstanceACLRulesResponse>;
|
|
418
329
|
protected pageOfListUsers: (request: Readonly<ListUsersRequest>) => Promise<ListUsersResponse>;
|
|
419
330
|
/**
|
|
420
|
-
* List users of a Database Instance. List all users of a given Database
|
|
421
|
-
* Instance. By default, the users returned in the list are ordered by
|
|
422
|
-
* creation date in ascending order, though this can be modified via the
|
|
423
|
-
* order_by field.
|
|
331
|
+
* 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.
|
|
424
332
|
*
|
|
425
333
|
* @param request - The request {@link ListUsersRequest}
|
|
426
334
|
* @returns A Promise of ListUsersResponse
|
|
@@ -430,38 +338,28 @@ export declare class API extends ParentAPI {
|
|
|
430
338
|
[Symbol.asyncIterator]: () => AsyncGenerator<User[], void, void>;
|
|
431
339
|
};
|
|
432
340
|
/**
|
|
433
|
-
* Create a user for a Database Instance. Create a new user for a Database
|
|
434
|
-
* Instance. You must define the `name`, `password` and `is_admin`
|
|
435
|
-
* parameters.
|
|
341
|
+
* 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.
|
|
436
342
|
*
|
|
437
343
|
* @param request - The request {@link CreateUserRequest}
|
|
438
344
|
* @returns A Promise of User
|
|
439
345
|
*/
|
|
440
346
|
createUser: (request: Readonly<CreateUserRequest>) => Promise<User>;
|
|
441
347
|
/**
|
|
442
|
-
* Update a user on a Database Instance. Update the parameters of a user on a
|
|
443
|
-
* Database Instance. You can update the `password` and `is_admin` parameters,
|
|
444
|
-
* but you cannot change the name of the user.
|
|
348
|
+
* 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.
|
|
445
349
|
*
|
|
446
350
|
* @param request - The request {@link UpdateUserRequest}
|
|
447
351
|
* @returns A Promise of User
|
|
448
352
|
*/
|
|
449
353
|
updateUser: (request: Readonly<UpdateUserRequest>) => Promise<User>;
|
|
450
354
|
/**
|
|
451
|
-
* Delete a user on a Database Instance. Delete a given user on a Database
|
|
452
|
-
* Instance. You must specify, in the endpoint, the `region`, `instance_id`
|
|
453
|
-
* and `name` parameters of the user you want to delete.
|
|
355
|
+
* 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.
|
|
454
356
|
*
|
|
455
357
|
* @param request - The request {@link DeleteUserRequest}
|
|
456
358
|
*/
|
|
457
359
|
deleteUser: (request: Readonly<DeleteUserRequest>) => Promise<void>;
|
|
458
360
|
protected pageOfListDatabases: (request: Readonly<ListDatabasesRequest>) => Promise<ListDatabasesResponse>;
|
|
459
361
|
/**
|
|
460
|
-
* List databases in a Database Instance. List all databases of a given
|
|
461
|
-
* Database Instance. By default, the databases returned in the list are
|
|
462
|
-
* ordered by creation date in ascending order, though this can be modified
|
|
463
|
-
* via the order_by field. You can define additional parameters for your
|
|
464
|
-
* query, such as `name`, `managed` and `owner`.
|
|
362
|
+
* 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`.
|
|
465
363
|
*
|
|
466
364
|
* @param request - The request {@link ListDatabasesRequest}
|
|
467
365
|
* @returns A Promise of ListDatabasesResponse
|
|
@@ -471,28 +369,21 @@ export declare class API extends ParentAPI {
|
|
|
471
369
|
[Symbol.asyncIterator]: () => AsyncGenerator<Database[], void, void>;
|
|
472
370
|
};
|
|
473
371
|
/**
|
|
474
|
-
* Create a database in a Database Instance. Create a new database. You must
|
|
475
|
-
* define the `name` parameter in the request.
|
|
372
|
+
* Create a database in a Database Instance. Create a new database. You must define the `name` parameter in the request.
|
|
476
373
|
*
|
|
477
374
|
* @param request - The request {@link CreateDatabaseRequest}
|
|
478
375
|
* @returns A Promise of Database
|
|
479
376
|
*/
|
|
480
377
|
createDatabase: (request: Readonly<CreateDatabaseRequest>) => Promise<Database>;
|
|
481
378
|
/**
|
|
482
|
-
* Delete a database in a Database Instance. Delete a given database on a
|
|
483
|
-
* Database Instance. You must specify, in the endpoint, the `region`,
|
|
484
|
-
* `instance_id` and `name` parameters of the database you want to delete.
|
|
379
|
+
* 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.
|
|
485
380
|
*
|
|
486
381
|
* @param request - The request {@link DeleteDatabaseRequest}
|
|
487
382
|
*/
|
|
488
383
|
deleteDatabase: (request: Readonly<DeleteDatabaseRequest>) => Promise<void>;
|
|
489
384
|
protected pageOfListPrivileges: (request: Readonly<ListPrivilegesRequest>) => Promise<ListPrivilegesResponse>;
|
|
490
385
|
/**
|
|
491
|
-
* List user privileges for a database. List privileges of a user on a
|
|
492
|
-
* database. By default, the details returned in the list are ordered by
|
|
493
|
-
* creation date in ascending order, though this can be modified via the
|
|
494
|
-
* order_by field. You can define additional parameters for your query, such
|
|
495
|
-
* as `database_name` and `user_name`.
|
|
386
|
+
* 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`.
|
|
496
387
|
*
|
|
497
388
|
* @param request - The request {@link ListPrivilegesRequest}
|
|
498
389
|
* @returns A Promise of ListPrivilegesResponse
|
|
@@ -502,9 +393,7 @@ export declare class API extends ParentAPI {
|
|
|
502
393
|
[Symbol.asyncIterator]: () => AsyncGenerator<Privilege[], void, void>;
|
|
503
394
|
};
|
|
504
395
|
/**
|
|
505
|
-
* Set user privileges for a database. Set the privileges of a user on a
|
|
506
|
-
* database. You must define `database_name`, `user_name` and `permission` in
|
|
507
|
-
* the request body.
|
|
396
|
+
* 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.
|
|
508
397
|
*
|
|
509
398
|
* @param request - The request {@link SetPrivilegeRequest}
|
|
510
399
|
* @returns A Promise of Privilege
|
|
@@ -512,11 +401,7 @@ export declare class API extends ParentAPI {
|
|
|
512
401
|
setPrivilege: (request: Readonly<SetPrivilegeRequest>) => Promise<Privilege>;
|
|
513
402
|
protected pageOfListSnapshots: (request?: Readonly<ListSnapshotsRequest>) => Promise<ListSnapshotsResponse>;
|
|
514
403
|
/**
|
|
515
|
-
* List snapshots. List snapshots. You can include the `instance_id` or
|
|
516
|
-
* `project_id` in your query to get the list of snapshots for specific
|
|
517
|
-
* Database Instances and/or Projects. By default, the details returned in the
|
|
518
|
-
* list are ordered by creation date in ascending order, though this can be
|
|
519
|
-
* modified via the `order_by` field.
|
|
404
|
+
* 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.
|
|
520
405
|
*
|
|
521
406
|
* @param request - The request {@link ListSnapshotsRequest}
|
|
522
407
|
* @returns A Promise of ListSnapshotsResponse
|
|
@@ -526,9 +411,7 @@ export declare class API extends ParentAPI {
|
|
|
526
411
|
[Symbol.asyncIterator]: () => AsyncGenerator<Snapshot[], void, void>;
|
|
527
412
|
};
|
|
528
413
|
/**
|
|
529
|
-
* Get a Database Instance snapshot. Retrieve information about a given
|
|
530
|
-
* snapshot, specified by its `snapshot_id` and `region`. Full details about
|
|
531
|
-
* the snapshot, like size and expiration date, are returned in the response.
|
|
414
|
+
* 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.
|
|
532
415
|
*
|
|
533
416
|
* @param request - The request {@link GetSnapshotRequest}
|
|
534
417
|
* @returns A Promise of Snapshot
|
|
@@ -543,68 +426,48 @@ export declare class API extends ParentAPI {
|
|
|
543
426
|
*/
|
|
544
427
|
waitForSnapshot: (request: Readonly<GetSnapshotRequest>, options?: Readonly<WaitForOptions<Snapshot>>) => Promise<Snapshot>;
|
|
545
428
|
/**
|
|
546
|
-
* Create a Database Instance snapshot. Create a new snapshot of a Database
|
|
547
|
-
* Instance. You must define the `name` parameter in the request.
|
|
429
|
+
* Create a Database Instance snapshot. Create a new snapshot of a Database Instance. You must define the `name` parameter in the request.
|
|
548
430
|
*
|
|
549
431
|
* @param request - The request {@link CreateSnapshotRequest}
|
|
550
432
|
* @returns A Promise of Snapshot
|
|
551
433
|
*/
|
|
552
434
|
createSnapshot: (request: Readonly<CreateSnapshotRequest>) => Promise<Snapshot>;
|
|
553
435
|
/**
|
|
554
|
-
* Update a Database Instance snapshot. Update the parameters of a snapshot of
|
|
555
|
-
* a Database Instance. You can update the `name` and `expires_at`
|
|
556
|
-
* parameters.
|
|
436
|
+
* Update a Database Instance snapshot. Update the parameters of a snapshot of a Database Instance. You can update the `name` and `expires_at` parameters.
|
|
557
437
|
*
|
|
558
438
|
* @param request - The request {@link UpdateSnapshotRequest}
|
|
559
439
|
* @returns A Promise of Snapshot
|
|
560
440
|
*/
|
|
561
441
|
updateSnapshot: (request: Readonly<UpdateSnapshotRequest>) => Promise<Snapshot>;
|
|
562
442
|
/**
|
|
563
|
-
* Delete a Database Instance snapshot. Delete a given snapshot of a Database
|
|
564
|
-
* Instance. You must specify, in the endpoint, the `region` and `snapshot_id`
|
|
565
|
-
* parameters of the snapshot you want to delete.
|
|
443
|
+
* 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.
|
|
566
444
|
*
|
|
567
445
|
* @param request - The request {@link DeleteSnapshotRequest}
|
|
568
446
|
* @returns A Promise of Snapshot
|
|
569
447
|
*/
|
|
570
448
|
deleteSnapshot: (request: Readonly<DeleteSnapshotRequest>) => Promise<Snapshot>;
|
|
571
449
|
/**
|
|
572
|
-
* Create a new Database Instance from a snapshot. Restore a snapshot. When
|
|
573
|
-
* you restore a snapshot, a new Instance is created and billed to your
|
|
574
|
-
* account. Note that is possible to select a larger node type for your new
|
|
575
|
-
* Database Instance. However, the Block volume size will be the same as the
|
|
576
|
-
* size of the restored snapshot. All Instance settings will be restored if
|
|
577
|
-
* you chose a node type with the same or more memory size than the initial
|
|
578
|
-
* Instance. Settings will be reset to the default if your node type has less
|
|
579
|
-
* memory.
|
|
450
|
+
* 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.
|
|
580
451
|
*
|
|
581
452
|
* @param request - The request {@link CreateInstanceFromSnapshotRequest}
|
|
582
453
|
* @returns A Promise of Instance
|
|
583
454
|
*/
|
|
584
455
|
createInstanceFromSnapshot: (request: Readonly<CreateInstanceFromSnapshotRequest>) => Promise<Instance>;
|
|
585
456
|
/**
|
|
586
|
-
* Create a new Database Instance endpoint. Create a new endpoint for a
|
|
587
|
-
* Database Instance. You can add `load_balancer` and `private_network`
|
|
588
|
-
* specifications to the body of the request.
|
|
457
|
+
* 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.
|
|
589
458
|
*
|
|
590
459
|
* @param request - The request {@link CreateEndpointRequest}
|
|
591
460
|
* @returns A Promise of Endpoint
|
|
592
461
|
*/
|
|
593
462
|
createEndpoint: (request: Readonly<CreateEndpointRequest>) => Promise<Endpoint>;
|
|
594
463
|
/**
|
|
595
|
-
* Delete a Database Instance endpoint. Delete the endpoint of a Database
|
|
596
|
-
* Instance. You must specify the `region` and `endpoint_id` parameters of the
|
|
597
|
-
* endpoint you want to delete. Note that might need to update any environment
|
|
598
|
-
* configurations that point to the deleted endpoint.
|
|
464
|
+
* 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.
|
|
599
465
|
*
|
|
600
466
|
* @param request - The request {@link DeleteEndpointRequest}
|
|
601
467
|
*/
|
|
602
468
|
deleteEndpoint: (request: Readonly<DeleteEndpointRequest>) => Promise<void>;
|
|
603
469
|
/**
|
|
604
|
-
* Get a Database Instance endpoint. Retrieve information about a Database
|
|
605
|
-
* Instance endpoint. Full details about the endpoint, like `ip`, `port`,
|
|
606
|
-
* `private_network` and `load_balancer` specifications are returned in the
|
|
607
|
-
* response.
|
|
470
|
+
* 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.
|
|
608
471
|
*
|
|
609
472
|
* @param request - The request {@link GetEndpointRequest}
|
|
610
473
|
* @returns A Promise of Endpoint
|
|
@@ -618,11 +481,7 @@ export declare class API extends ParentAPI {
|
|
|
618
481
|
*/
|
|
619
482
|
migrateEndpoint: (request: Readonly<MigrateEndpointRequest>) => Promise<Endpoint>;
|
|
620
483
|
/**
|
|
621
|
-
* Apply Database Instance maintenance. Apply maintenance tasks to your
|
|
622
|
-
* Database Instance. This will trigger pending maintenance tasks to start in
|
|
623
|
-
* your Database Instance and can generate service interruption. Maintenance
|
|
624
|
-
* tasks can be applied between `starts_at` and `stops_at` times, and are run
|
|
625
|
-
* directly by Scaleway at `forced_at` timestamp.
|
|
484
|
+
* 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.
|
|
626
485
|
*
|
|
627
486
|
* @param request - The request {@link ApplyInstanceMaintenanceRequest}
|
|
628
487
|
* @returns A Promise of Maintenance
|