@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
|
@@ -22,10 +22,7 @@ class API extends api.API {
|
|
|
22
22
|
"pl-waw-2"
|
|
23
23
|
];
|
|
24
24
|
/**
|
|
25
|
-
* Create a Redis™ Database Instance. Create a new Redis™ Database Instance
|
|
26
|
-
* (Redis™ cluster). You must set the `zone`, `project_id`, `version`,
|
|
27
|
-
* `node_type`, `user_name` and `password` parameters. Optionally you can
|
|
28
|
-
* define `acl_rules`, `endpoints`, `tls_enabled` and `cluster_settings`.
|
|
25
|
+
* Create a Redis™ Database Instance. Create a new Redis™ Database Instance (Redis™ cluster). You must set the `zone`, `project_id`, `version`, `node_type`, `user_name` and `password` parameters. Optionally you can define `acl_rules`, `endpoints`, `tls_enabled` and `cluster_settings`.
|
|
29
26
|
*
|
|
30
27
|
* @param request - The request {@link CreateClusterRequest}
|
|
31
28
|
* @returns A Promise of Cluster
|
|
@@ -42,9 +39,7 @@ class API extends api.API {
|
|
|
42
39
|
marshalling_gen.unmarshalCluster
|
|
43
40
|
);
|
|
44
41
|
/**
|
|
45
|
-
* Update a Redis™ Database Instance. Update the parameters of a Redis™
|
|
46
|
-
* Database Instance (Redis™ cluster), including `name`, `tags`, `user_name`
|
|
47
|
-
* and `password`.
|
|
42
|
+
* Update a Redis™ Database Instance. Update the parameters of a Redis™ Database Instance (Redis™ cluster), including `name`, `tags`, `user_name` and `password`.
|
|
48
43
|
*
|
|
49
44
|
* @param request - The request {@link UpdateClusterRequest}
|
|
50
45
|
* @returns A Promise of Cluster
|
|
@@ -61,11 +56,7 @@ class API extends api.API {
|
|
|
61
56
|
marshalling_gen.unmarshalCluster
|
|
62
57
|
);
|
|
63
58
|
/**
|
|
64
|
-
* Get a Redis™ Database Instance. Retrieve information about a Redis™
|
|
65
|
-
* Database Instance (Redis™ cluster). Specify the `cluster_id` and `region`
|
|
66
|
-
* in your request to get information such as `id`, `status`, `version`,
|
|
67
|
-
* `tls_enabled`, `cluster_settings`, `upgradable_versions` and `endpoints`
|
|
68
|
-
* about your cluster in the response.
|
|
59
|
+
* Get a Redis™ Database Instance. Retrieve information about a Redis™ Database Instance (Redis™ cluster). Specify the `cluster_id` and `region` in your request to get information such as `id`, `status`, `version`, `tls_enabled`, `cluster_settings`, `upgradable_versions` and `endpoints` about your cluster in the response.
|
|
69
60
|
*
|
|
70
61
|
* @param request - The request {@link GetClusterRequest}
|
|
71
62
|
* @returns A Promise of Cluster
|
|
@@ -113,25 +104,14 @@ class API extends api.API {
|
|
|
113
104
|
marshalling_gen.unmarshalListClustersResponse
|
|
114
105
|
);
|
|
115
106
|
/**
|
|
116
|
-
* List Redis™ Database Instances. List all Redis™ Database Instances (Redis™
|
|
117
|
-
* cluster) in the specified zone. By default, the Database Instances returned
|
|
118
|
-
* in the list are ordered by creation date in ascending order, though this
|
|
119
|
-
* can be modified via the order_by field. You can define additional
|
|
120
|
-
* parameters for your query, such as `tags`, `name`, `organization_id` and
|
|
121
|
-
* `version`.
|
|
107
|
+
* List Redis™ Database Instances. List all Redis™ Database Instances (Redis™ cluster) in the specified zone. 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`, `name`, `organization_id` and `version`.
|
|
122
108
|
*
|
|
123
109
|
* @param request - The request {@link ListClustersRequest}
|
|
124
110
|
* @returns A Promise of ListClustersResponse
|
|
125
111
|
*/
|
|
126
112
|
listClusters = (request = {}) => resourcePaginator.enrichForPagination("clusters", this.pageOfListClusters, request);
|
|
127
113
|
/**
|
|
128
|
-
* Scale up a Redis™ Database Instance. Upgrade your Redis™ Database Instance,
|
|
129
|
-
* either by upgrading to a bigger node type (vertical scaling) or by adding
|
|
130
|
-
* more nodes to your Database Instance to increase your number of endpoints
|
|
131
|
-
* and distribute cache (horizontal scaling, available for clusters only).
|
|
132
|
-
* Note that scaling horizontally your Redis™ Database Instance will not renew
|
|
133
|
-
* its TLS certificate. In order to refresh the TLS certificate, you must use
|
|
134
|
-
* the Renew TLS certificate endpoint.
|
|
114
|
+
* Scale up a Redis™ Database Instance. Upgrade your Redis™ Database Instance, either by upgrading to a bigger node type (vertical scaling) or by adding more nodes to your Database Instance to increase your number of endpoints and distribute cache (horizontal scaling, available for clusters only). Note that scaling horizontally your Redis™ Database Instance will not renew its TLS certificate. In order to refresh the TLS certificate, you must use the Renew TLS certificate endpoint.
|
|
135
115
|
*
|
|
136
116
|
* @param request - The request {@link MigrateClusterRequest}
|
|
137
117
|
* @returns A Promise of Cluster
|
|
@@ -148,10 +128,7 @@ class API extends api.API {
|
|
|
148
128
|
marshalling_gen.unmarshalCluster
|
|
149
129
|
);
|
|
150
130
|
/**
|
|
151
|
-
* Delete a Redis™ Database Instance. Delete a Redis™ Database Instance
|
|
152
|
-
* (Redis™ cluster), specified by the `region` and `cluster_id` parameters.
|
|
153
|
-
* Deleting a Database Instance is permanent, and cannot be undone. Note that
|
|
154
|
-
* upon deletion all your data will be lost.
|
|
131
|
+
* Delete a Redis™ Database Instance. Delete a Redis™ Database Instance (Redis™ cluster), specified by the `region` and `cluster_id` parameters. Deleting a Database Instance is permanent, and cannot be undone. Note that upon deletion all your data will be lost.
|
|
155
132
|
*
|
|
156
133
|
* @param request - The request {@link DeleteClusterRequest}
|
|
157
134
|
* @returns A Promise of Cluster
|
|
@@ -164,9 +141,7 @@ class API extends api.API {
|
|
|
164
141
|
marshalling_gen.unmarshalCluster
|
|
165
142
|
);
|
|
166
143
|
/**
|
|
167
|
-
* Get metrics of a Redis™ Database Instance. Retrieve the metrics of a Redis™
|
|
168
|
-
* Database Instance (Redis™ cluster). You can define the period from which to
|
|
169
|
-
* retrieve metrics by specifying the `start_date` and `end_date`.
|
|
144
|
+
* Get metrics of a Redis™ Database Instance. Retrieve the metrics of a Redis™ Database Instance (Redis™ cluster). You can define the period from which to retrieve metrics by specifying the `start_date` and `end_date`.
|
|
170
145
|
*
|
|
171
146
|
* @param request - The request {@link GetClusterMetricsRequest}
|
|
172
147
|
* @returns A Promise of ClusterMetricsResponse
|
|
@@ -199,9 +174,7 @@ class API extends api.API {
|
|
|
199
174
|
marshalling_gen.unmarshalListNodeTypesResponse
|
|
200
175
|
);
|
|
201
176
|
/**
|
|
202
|
-
* List available node types. List all available node types. By default, the
|
|
203
|
-
* node types returned in the list are ordered by creation date in ascending
|
|
204
|
-
* order, though this can be modified via the `order_by` field.
|
|
177
|
+
* 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.
|
|
205
178
|
*
|
|
206
179
|
* @param request - The request {@link ListNodeTypesRequest}
|
|
207
180
|
* @returns A Promise of ListNodeTypesResponse
|
|
@@ -226,18 +199,14 @@ class API extends api.API {
|
|
|
226
199
|
marshalling_gen.unmarshalListClusterVersionsResponse
|
|
227
200
|
);
|
|
228
201
|
/**
|
|
229
|
-
* List available Redis™ versions. List the Redis™ database engine versions
|
|
230
|
-
* available. You can define additional parameters for your query, such as
|
|
231
|
-
* `include_disabled`, `include_beta`, `include_deprecated` and `version`.
|
|
202
|
+
* List available Redis™ versions. List the Redis™ database engine versions available. You can define additional parameters for your query, such as `include_disabled`, `include_beta`, `include_deprecated` and `version`.
|
|
232
203
|
*
|
|
233
204
|
* @param request - The request {@link ListClusterVersionsRequest}
|
|
234
205
|
* @returns A Promise of ListClusterVersionsResponse
|
|
235
206
|
*/
|
|
236
207
|
listClusterVersions = (request) => resourcePaginator.enrichForPagination("versions", this.pageOfListClusterVersions, request);
|
|
237
208
|
/**
|
|
238
|
-
* Get the TLS certificate of a cluster. Retrieve information about the TLS
|
|
239
|
-
* certificate of a Redis™ Database Instance (Redis™ cluster). Details like
|
|
240
|
-
* name and content are returned in the response.
|
|
209
|
+
* Get the TLS certificate of a cluster. Retrieve information about the TLS certificate of a Redis™ Database Instance (Redis™ cluster). Details like name and content are returned in the response.
|
|
241
210
|
*
|
|
242
211
|
* @param request - The request {@link GetClusterCertificateRequest}
|
|
243
212
|
* @returns A Promise of Blob
|
|
@@ -249,11 +218,7 @@ class API extends api.API {
|
|
|
249
218
|
responseType: "blob"
|
|
250
219
|
});
|
|
251
220
|
/**
|
|
252
|
-
* Renew the TLS certificate of a cluster. Renew a TLS certificate for a
|
|
253
|
-
* Redis™ Database Instance (Redis™ cluster). Renewing a certificate means
|
|
254
|
-
* that you will not be able to connect to your Database Instance using the
|
|
255
|
-
* previous certificate. You will also need to download and update the new
|
|
256
|
-
* certificate for all database clients.
|
|
221
|
+
* Renew the TLS certificate of a cluster. Renew a TLS certificate for a Redis™ Database Instance (Redis™ cluster). 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.
|
|
257
222
|
*
|
|
258
223
|
* @param request - The request {@link RenewClusterCertificateRequest}
|
|
259
224
|
* @returns A Promise of Cluster
|
|
@@ -268,9 +233,7 @@ class API extends api.API {
|
|
|
268
233
|
marshalling_gen.unmarshalCluster
|
|
269
234
|
);
|
|
270
235
|
/**
|
|
271
|
-
* Add advanced settings. Add an advanced setting to a Redis™ Database
|
|
272
|
-
* Instance (Redis™ cluster). You must set the `name` and the `value` of each
|
|
273
|
-
* setting.
|
|
236
|
+
* Add advanced settings. Add an advanced setting to a Redis™ Database Instance (Redis™ cluster). You must set the `name` and the `value` of each setting.
|
|
274
237
|
*
|
|
275
238
|
* @param request - The request {@link AddClusterSettingsRequest}
|
|
276
239
|
* @returns A Promise of ClusterSettingsResponse
|
|
@@ -287,9 +250,7 @@ class API extends api.API {
|
|
|
287
250
|
marshalling_gen.unmarshalClusterSettingsResponse
|
|
288
251
|
);
|
|
289
252
|
/**
|
|
290
|
-
* Delete advanced setting. Delete an advanced setting in a Redis™ Database
|
|
291
|
-
* Instance (Redis™ cluster). You must specify the names of the settings you
|
|
292
|
-
* want to delete in the request body.
|
|
253
|
+
* Delete advanced setting. Delete an advanced setting in a Redis™ Database Instance (Redis™ cluster). You must specify the names of the settings you want to delete in the request body.
|
|
293
254
|
*
|
|
294
255
|
* @param request - The request {@link DeleteClusterSettingRequest}
|
|
295
256
|
* @returns A Promise of Cluster
|
|
@@ -302,9 +263,7 @@ class API extends api.API {
|
|
|
302
263
|
marshalling_gen.unmarshalCluster
|
|
303
264
|
);
|
|
304
265
|
/**
|
|
305
|
-
* Set advanced settings. Update an advanced setting for a Redis™ Database
|
|
306
|
-
* Instance (Redis™ cluster). Settings added upon database engine
|
|
307
|
-
* initalization can only be defined once, and cannot, therefore, be updated.
|
|
266
|
+
* Set advanced settings. Update an advanced setting for a Redis™ Database Instance (Redis™ cluster). Settings added upon database engine initalization can only be defined once, and cannot, therefore, be updated.
|
|
308
267
|
*
|
|
309
268
|
* @param request - The request {@link SetClusterSettingsRequest}
|
|
310
269
|
* @returns A Promise of ClusterSettingsResponse
|
|
@@ -321,8 +280,7 @@ class API extends api.API {
|
|
|
321
280
|
marshalling_gen.unmarshalClusterSettingsResponse
|
|
322
281
|
);
|
|
323
282
|
/**
|
|
324
|
-
* Set ACL rules for a cluster. Replace all the ACL rules of a Redis™ Database
|
|
325
|
-
* Instance (Redis™ cluster).
|
|
283
|
+
* Set ACL rules for a cluster. Replace all the ACL rules of a Redis™ Database Instance (Redis™ cluster).
|
|
326
284
|
*
|
|
327
285
|
* @param request - The request {@link SetAclRulesRequest}
|
|
328
286
|
* @returns A Promise of SetAclRulesResponse
|
|
@@ -339,8 +297,7 @@ class API extends api.API {
|
|
|
339
297
|
marshalling_gen.unmarshalSetAclRulesResponse
|
|
340
298
|
);
|
|
341
299
|
/**
|
|
342
|
-
* Add ACL rules for a cluster. Add an additional ACL rule to a Redis™
|
|
343
|
-
* Database Instance (Redis™ cluster).
|
|
300
|
+
* Add ACL rules for a cluster. Add an additional ACL rule to a Redis™ Database Instance (Redis™ cluster).
|
|
344
301
|
*
|
|
345
302
|
* @param request - The request {@link AddAclRulesRequest}
|
|
346
303
|
* @returns A Promise of AddAclRulesResponse
|
|
@@ -357,9 +314,7 @@ class API extends api.API {
|
|
|
357
314
|
marshalling_gen.unmarshalAddAclRulesResponse
|
|
358
315
|
);
|
|
359
316
|
/**
|
|
360
|
-
* Delete an ACL rule for a cluster. Delete an ACL rule of a Redis™ Database
|
|
361
|
-
* Instance (Redis™ cluster). You must specify the `acl_id` of the rule you
|
|
362
|
-
* want to delete in your request.
|
|
317
|
+
* Delete an ACL rule for a cluster. Delete an ACL rule of a Redis™ Database Instance (Redis™ cluster). You must specify the `acl_id` of the rule you want to delete in your request.
|
|
363
318
|
*
|
|
364
319
|
* @param request - The request {@link DeleteAclRuleRequest}
|
|
365
320
|
* @returns A Promise of Cluster
|
|
@@ -372,9 +327,7 @@ class API extends api.API {
|
|
|
372
327
|
marshalling_gen.unmarshalCluster
|
|
373
328
|
);
|
|
374
329
|
/**
|
|
375
|
-
* Get an ACL rule. Retrieve information about an ACL rule of a Redis™
|
|
376
|
-
* Database Instance (Redis™ cluster). You must specify the `acl_id` of the
|
|
377
|
-
* rule in your request.
|
|
330
|
+
* Get an ACL rule. Retrieve information about an ACL rule of a Redis™ Database Instance (Redis™ cluster). You must specify the `acl_id` of the rule in your request.
|
|
378
331
|
*
|
|
379
332
|
* @param request - The request {@link GetAclRuleRequest}
|
|
380
333
|
* @returns A Promise of ACLRule
|
|
@@ -387,9 +340,7 @@ class API extends api.API {
|
|
|
387
340
|
marshalling_gen.unmarshalACLRule
|
|
388
341
|
);
|
|
389
342
|
/**
|
|
390
|
-
* Set endpoints for a cluster. Update an endpoint for a Redis™ Database
|
|
391
|
-
* Instance (Redis™ cluster). You must specify the `cluster_id` and the
|
|
392
|
-
* `endpoints` parameters in your request.
|
|
343
|
+
* Set endpoints for a cluster. Update an endpoint for a Redis™ Database Instance (Redis™ cluster). You must specify the `cluster_id` and the `endpoints` parameters in your request.
|
|
393
344
|
*
|
|
394
345
|
* @param request - The request {@link SetEndpointsRequest}
|
|
395
346
|
* @returns A Promise of SetEndpointsResponse
|
|
@@ -406,9 +357,7 @@ class API extends api.API {
|
|
|
406
357
|
marshalling_gen.unmarshalSetEndpointsResponse
|
|
407
358
|
);
|
|
408
359
|
/**
|
|
409
|
-
* Add endpoints for a cluster. Add a new endpoint for a Redis™ Database
|
|
410
|
-
* Instance (Redis™ cluster). You can add `private_network` or
|
|
411
|
-
* `public_network` specifications to the body of the request.
|
|
360
|
+
* Add endpoints for a cluster. Add a new endpoint for a Redis™ Database Instance (Redis™ cluster). You can add `private_network` or `public_network` specifications to the body of the request.
|
|
412
361
|
*
|
|
413
362
|
* @param request - The request {@link AddEndpointsRequest}
|
|
414
363
|
* @returns A Promise of AddEndpointsResponse
|
|
@@ -425,10 +374,7 @@ class API extends api.API {
|
|
|
425
374
|
marshalling_gen.unmarshalAddEndpointsResponse
|
|
426
375
|
);
|
|
427
376
|
/**
|
|
428
|
-
* Delete an endpoint for a cluster. Delete the endpoint of a Redis™ Database
|
|
429
|
-
* Instance (Redis™ cluster). You must specify the `region` and `endpoint_id`
|
|
430
|
-
* parameters of the endpoint you want to delete. Note that might need to
|
|
431
|
-
* update any environment configurations that point to the deleted endpoint.
|
|
377
|
+
* Delete an endpoint for a cluster. Delete the endpoint of a Redis™ Database Instance (Redis™ cluster). 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.
|
|
432
378
|
*
|
|
433
379
|
* @param request - The request {@link DeleteEndpointRequest}
|
|
434
380
|
* @returns A Promise of Cluster
|
|
@@ -441,10 +387,7 @@ class API extends api.API {
|
|
|
441
387
|
marshalling_gen.unmarshalCluster
|
|
442
388
|
);
|
|
443
389
|
/**
|
|
444
|
-
* Get an endpoint. Retrieve information about a Redis™ Database Instance
|
|
445
|
-
* (Redis™ cluster) endpoint. Full details about the endpoint, like `ips`,
|
|
446
|
-
* `port`, `private_network` and `public_network` specifications are returned
|
|
447
|
-
* in the response.
|
|
390
|
+
* Get an endpoint. Retrieve information about a Redis™ Database Instance (Redis™ cluster) endpoint. Full details about the endpoint, like `ips`, `port`, `private_network` and `public_network` specifications are returned in the response.
|
|
448
391
|
*
|
|
449
392
|
* @param request - The request {@link GetEndpointRequest}
|
|
450
393
|
* @returns A Promise of Endpoint
|
|
@@ -457,10 +400,7 @@ class API extends api.API {
|
|
|
457
400
|
marshalling_gen.unmarshalEndpoint
|
|
458
401
|
);
|
|
459
402
|
/**
|
|
460
|
-
* Update an endpoint. Update information about a Redis™ Database Instance
|
|
461
|
-
* (Redis™ cluster) endpoint. Full details about the endpoint, like `ips`,
|
|
462
|
-
* `port`, `private_network` and `public_network` specifications are returned
|
|
463
|
-
* in the response.
|
|
403
|
+
* Update an endpoint. Update information about a Redis™ Database Instance (Redis™ cluster) endpoint. Full details about the endpoint, like `ips`, `port`, `private_network` and `public_network` specifications are returned in the response.
|
|
464
404
|
*
|
|
465
405
|
* @param request - The request {@link UpdateEndpointRequest}
|
|
466
406
|
* @returns A Promise of Endpoint
|
|
@@ -3,37 +3,28 @@ import type { Zone as ScwZone, WaitForOptions } from '@scaleway/sdk-client';
|
|
|
3
3
|
import type { ACLRule, AddAclRulesRequest, AddAclRulesResponse, AddClusterSettingsRequest, AddEndpointsRequest, AddEndpointsResponse, Cluster, ClusterMetricsResponse, ClusterSettingsResponse, CreateClusterRequest, DeleteAclRuleRequest, DeleteClusterRequest, DeleteClusterSettingRequest, DeleteEndpointRequest, Endpoint, GetAclRuleRequest, GetClusterCertificateRequest, GetClusterMetricsRequest, GetClusterRequest, GetEndpointRequest, ListClusterVersionsRequest, ListClusterVersionsResponse, ListClustersRequest, ListClustersResponse, ListNodeTypesRequest, ListNodeTypesResponse, MigrateClusterRequest, RenewClusterCertificateRequest, SetAclRulesRequest, SetAclRulesResponse, SetClusterSettingsRequest, SetEndpointsRequest, SetEndpointsResponse, UpdateClusterRequest, UpdateEndpointRequest } from './types.gen';
|
|
4
4
|
/**
|
|
5
5
|
* Managed Database for Redis™ API.
|
|
6
|
-
|
|
7
|
-
|
|
6
|
+
|
|
7
|
+
This API allows you to manage your Managed Databases for Redis™.
|
|
8
8
|
*/
|
|
9
9
|
export declare class API extends ParentAPI {
|
|
10
10
|
/** Lists the available zones of the API. */
|
|
11
11
|
static readonly LOCALITIES: ScwZone[];
|
|
12
12
|
/**
|
|
13
|
-
* Create a Redis™ Database Instance. Create a new Redis™ Database Instance
|
|
14
|
-
* (Redis™ cluster). You must set the `zone`, `project_id`, `version`,
|
|
15
|
-
* `node_type`, `user_name` and `password` parameters. Optionally you can
|
|
16
|
-
* define `acl_rules`, `endpoints`, `tls_enabled` and `cluster_settings`.
|
|
13
|
+
* Create a Redis™ Database Instance. Create a new Redis™ Database Instance (Redis™ cluster). You must set the `zone`, `project_id`, `version`, `node_type`, `user_name` and `password` parameters. Optionally you can define `acl_rules`, `endpoints`, `tls_enabled` and `cluster_settings`.
|
|
17
14
|
*
|
|
18
15
|
* @param request - The request {@link CreateClusterRequest}
|
|
19
16
|
* @returns A Promise of Cluster
|
|
20
17
|
*/
|
|
21
18
|
createCluster: (request: Readonly<CreateClusterRequest>) => Promise<Cluster>;
|
|
22
19
|
/**
|
|
23
|
-
* Update a Redis™ Database Instance. Update the parameters of a Redis™
|
|
24
|
-
* Database Instance (Redis™ cluster), including `name`, `tags`, `user_name`
|
|
25
|
-
* and `password`.
|
|
20
|
+
* Update a Redis™ Database Instance. Update the parameters of a Redis™ Database Instance (Redis™ cluster), including `name`, `tags`, `user_name` and `password`.
|
|
26
21
|
*
|
|
27
22
|
* @param request - The request {@link UpdateClusterRequest}
|
|
28
23
|
* @returns A Promise of Cluster
|
|
29
24
|
*/
|
|
30
25
|
updateCluster: (request: Readonly<UpdateClusterRequest>) => Promise<Cluster>;
|
|
31
26
|
/**
|
|
32
|
-
* Get a Redis™ Database Instance. Retrieve information about a Redis™
|
|
33
|
-
* Database Instance (Redis™ cluster). Specify the `cluster_id` and `region`
|
|
34
|
-
* in your request to get information such as `id`, `status`, `version`,
|
|
35
|
-
* `tls_enabled`, `cluster_settings`, `upgradable_versions` and `endpoints`
|
|
36
|
-
* about your cluster in the response.
|
|
27
|
+
* Get a Redis™ Database Instance. Retrieve information about a Redis™ Database Instance (Redis™ cluster). Specify the `cluster_id` and `region` in your request to get information such as `id`, `status`, `version`, `tls_enabled`, `cluster_settings`, `upgradable_versions` and `endpoints` about your cluster in the response.
|
|
37
28
|
*
|
|
38
29
|
* @param request - The request {@link GetClusterRequest}
|
|
39
30
|
* @returns A Promise of Cluster
|
|
@@ -49,12 +40,7 @@ export declare class API extends ParentAPI {
|
|
|
49
40
|
waitForCluster: (request: Readonly<GetClusterRequest>, options?: Readonly<WaitForOptions<Cluster>>) => Promise<Cluster>;
|
|
50
41
|
protected pageOfListClusters: (request?: Readonly<ListClustersRequest>) => Promise<ListClustersResponse>;
|
|
51
42
|
/**
|
|
52
|
-
* List Redis™ Database Instances. List all Redis™ Database Instances (Redis™
|
|
53
|
-
* cluster) in the specified zone. By default, the Database Instances returned
|
|
54
|
-
* in the list are ordered by creation date in ascending order, though this
|
|
55
|
-
* can be modified via the order_by field. You can define additional
|
|
56
|
-
* parameters for your query, such as `tags`, `name`, `organization_id` and
|
|
57
|
-
* `version`.
|
|
43
|
+
* List Redis™ Database Instances. List all Redis™ Database Instances (Redis™ cluster) in the specified zone. 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`, `name`, `organization_id` and `version`.
|
|
58
44
|
*
|
|
59
45
|
* @param request - The request {@link ListClustersRequest}
|
|
60
46
|
* @returns A Promise of ListClustersResponse
|
|
@@ -64,32 +50,21 @@ export declare class API extends ParentAPI {
|
|
|
64
50
|
[Symbol.asyncIterator]: () => AsyncGenerator<Cluster[], void, void>;
|
|
65
51
|
};
|
|
66
52
|
/**
|
|
67
|
-
* Scale up a Redis™ Database Instance. Upgrade your Redis™ Database Instance,
|
|
68
|
-
* either by upgrading to a bigger node type (vertical scaling) or by adding
|
|
69
|
-
* more nodes to your Database Instance to increase your number of endpoints
|
|
70
|
-
* and distribute cache (horizontal scaling, available for clusters only).
|
|
71
|
-
* Note that scaling horizontally your Redis™ Database Instance will not renew
|
|
72
|
-
* its TLS certificate. In order to refresh the TLS certificate, you must use
|
|
73
|
-
* the Renew TLS certificate endpoint.
|
|
53
|
+
* Scale up a Redis™ Database Instance. Upgrade your Redis™ Database Instance, either by upgrading to a bigger node type (vertical scaling) or by adding more nodes to your Database Instance to increase your number of endpoints and distribute cache (horizontal scaling, available for clusters only). Note that scaling horizontally your Redis™ Database Instance will not renew its TLS certificate. In order to refresh the TLS certificate, you must use the Renew TLS certificate endpoint.
|
|
74
54
|
*
|
|
75
55
|
* @param request - The request {@link MigrateClusterRequest}
|
|
76
56
|
* @returns A Promise of Cluster
|
|
77
57
|
*/
|
|
78
58
|
migrateCluster: (request: Readonly<MigrateClusterRequest>) => Promise<Cluster>;
|
|
79
59
|
/**
|
|
80
|
-
* Delete a Redis™ Database Instance. Delete a Redis™ Database Instance
|
|
81
|
-
* (Redis™ cluster), specified by the `region` and `cluster_id` parameters.
|
|
82
|
-
* Deleting a Database Instance is permanent, and cannot be undone. Note that
|
|
83
|
-
* upon deletion all your data will be lost.
|
|
60
|
+
* Delete a Redis™ Database Instance. Delete a Redis™ Database Instance (Redis™ cluster), specified by the `region` and `cluster_id` parameters. Deleting a Database Instance is permanent, and cannot be undone. Note that upon deletion all your data will be lost.
|
|
84
61
|
*
|
|
85
62
|
* @param request - The request {@link DeleteClusterRequest}
|
|
86
63
|
* @returns A Promise of Cluster
|
|
87
64
|
*/
|
|
88
65
|
deleteCluster: (request: Readonly<DeleteClusterRequest>) => Promise<Cluster>;
|
|
89
66
|
/**
|
|
90
|
-
* Get metrics of a Redis™ Database Instance. Retrieve the metrics of a Redis™
|
|
91
|
-
* Database Instance (Redis™ cluster). You can define the period from which to
|
|
92
|
-
* retrieve metrics by specifying the `start_date` and `end_date`.
|
|
67
|
+
* Get metrics of a Redis™ Database Instance. Retrieve the metrics of a Redis™ Database Instance (Redis™ cluster). You can define the period from which to retrieve metrics by specifying the `start_date` and `end_date`.
|
|
93
68
|
*
|
|
94
69
|
* @param request - The request {@link GetClusterMetricsRequest}
|
|
95
70
|
* @returns A Promise of ClusterMetricsResponse
|
|
@@ -97,9 +72,7 @@ export declare class API extends ParentAPI {
|
|
|
97
72
|
getClusterMetrics: (request: Readonly<GetClusterMetricsRequest>) => Promise<ClusterMetricsResponse>;
|
|
98
73
|
protected pageOfListNodeTypes: (request: Readonly<ListNodeTypesRequest>) => Promise<ListNodeTypesResponse>;
|
|
99
74
|
/**
|
|
100
|
-
* List available node types. List all available node types. By default, the
|
|
101
|
-
* node types returned in the list are ordered by creation date in ascending
|
|
102
|
-
* order, though this can be modified via the `order_by` field.
|
|
75
|
+
* 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.
|
|
103
76
|
*
|
|
104
77
|
* @param request - The request {@link ListNodeTypesRequest}
|
|
105
78
|
* @returns A Promise of ListNodeTypesResponse
|
|
@@ -110,9 +83,7 @@ export declare class API extends ParentAPI {
|
|
|
110
83
|
};
|
|
111
84
|
protected pageOfListClusterVersions: (request: Readonly<ListClusterVersionsRequest>) => Promise<ListClusterVersionsResponse>;
|
|
112
85
|
/**
|
|
113
|
-
* List available Redis™ versions. List the Redis™ database engine versions
|
|
114
|
-
* available. You can define additional parameters for your query, such as
|
|
115
|
-
* `include_disabled`, `include_beta`, `include_deprecated` and `version`.
|
|
86
|
+
* List available Redis™ versions. List the Redis™ database engine versions available. You can define additional parameters for your query, such as `include_disabled`, `include_beta`, `include_deprecated` and `version`.
|
|
116
87
|
*
|
|
117
88
|
* @param request - The request {@link ListClusterVersionsRequest}
|
|
118
89
|
* @returns A Promise of ListClusterVersionsResponse
|
|
@@ -122,129 +93,98 @@ export declare class API extends ParentAPI {
|
|
|
122
93
|
[Symbol.asyncIterator]: () => AsyncGenerator<import("./types.gen").ClusterVersion[], void, void>;
|
|
123
94
|
};
|
|
124
95
|
/**
|
|
125
|
-
* Get the TLS certificate of a cluster. Retrieve information about the TLS
|
|
126
|
-
* certificate of a Redis™ Database Instance (Redis™ cluster). Details like
|
|
127
|
-
* name and content are returned in the response.
|
|
96
|
+
* Get the TLS certificate of a cluster. Retrieve information about the TLS certificate of a Redis™ Database Instance (Redis™ cluster). Details like name and content are returned in the response.
|
|
128
97
|
*
|
|
129
98
|
* @param request - The request {@link GetClusterCertificateRequest}
|
|
130
99
|
* @returns A Promise of Blob
|
|
131
100
|
*/
|
|
132
101
|
getClusterCertificate: (request: Readonly<GetClusterCertificateRequest>) => Promise<Blob>;
|
|
133
102
|
/**
|
|
134
|
-
* Renew the TLS certificate of a cluster. Renew a TLS certificate for a
|
|
135
|
-
* Redis™ Database Instance (Redis™ cluster). Renewing a certificate means
|
|
136
|
-
* that you will not be able to connect to your Database Instance using the
|
|
137
|
-
* previous certificate. You will also need to download and update the new
|
|
138
|
-
* certificate for all database clients.
|
|
103
|
+
* Renew the TLS certificate of a cluster. Renew a TLS certificate for a Redis™ Database Instance (Redis™ cluster). 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.
|
|
139
104
|
*
|
|
140
105
|
* @param request - The request {@link RenewClusterCertificateRequest}
|
|
141
106
|
* @returns A Promise of Cluster
|
|
142
107
|
*/
|
|
143
108
|
renewClusterCertificate: (request: Readonly<RenewClusterCertificateRequest>) => Promise<Cluster>;
|
|
144
109
|
/**
|
|
145
|
-
* Add advanced settings. Add an advanced setting to a Redis™ Database
|
|
146
|
-
* Instance (Redis™ cluster). You must set the `name` and the `value` of each
|
|
147
|
-
* setting.
|
|
110
|
+
* Add advanced settings. Add an advanced setting to a Redis™ Database Instance (Redis™ cluster). You must set the `name` and the `value` of each setting.
|
|
148
111
|
*
|
|
149
112
|
* @param request - The request {@link AddClusterSettingsRequest}
|
|
150
113
|
* @returns A Promise of ClusterSettingsResponse
|
|
151
114
|
*/
|
|
152
115
|
addClusterSettings: (request: Readonly<AddClusterSettingsRequest>) => Promise<ClusterSettingsResponse>;
|
|
153
116
|
/**
|
|
154
|
-
* Delete advanced setting. Delete an advanced setting in a Redis™ Database
|
|
155
|
-
* Instance (Redis™ cluster). You must specify the names of the settings you
|
|
156
|
-
* want to delete in the request body.
|
|
117
|
+
* Delete advanced setting. Delete an advanced setting in a Redis™ Database Instance (Redis™ cluster). You must specify the names of the settings you want to delete in the request body.
|
|
157
118
|
*
|
|
158
119
|
* @param request - The request {@link DeleteClusterSettingRequest}
|
|
159
120
|
* @returns A Promise of Cluster
|
|
160
121
|
*/
|
|
161
122
|
deleteClusterSetting: (request: Readonly<DeleteClusterSettingRequest>) => Promise<Cluster>;
|
|
162
123
|
/**
|
|
163
|
-
* Set advanced settings. Update an advanced setting for a Redis™ Database
|
|
164
|
-
* Instance (Redis™ cluster). Settings added upon database engine
|
|
165
|
-
* initalization can only be defined once, and cannot, therefore, be updated.
|
|
124
|
+
* Set advanced settings. Update an advanced setting for a Redis™ Database Instance (Redis™ cluster). Settings added upon database engine initalization can only be defined once, and cannot, therefore, be updated.
|
|
166
125
|
*
|
|
167
126
|
* @param request - The request {@link SetClusterSettingsRequest}
|
|
168
127
|
* @returns A Promise of ClusterSettingsResponse
|
|
169
128
|
*/
|
|
170
129
|
setClusterSettings: (request: Readonly<SetClusterSettingsRequest>) => Promise<ClusterSettingsResponse>;
|
|
171
130
|
/**
|
|
172
|
-
* Set ACL rules for a cluster. Replace all the ACL rules of a Redis™ Database
|
|
173
|
-
* Instance (Redis™ cluster).
|
|
131
|
+
* Set ACL rules for a cluster. Replace all the ACL rules of a Redis™ Database Instance (Redis™ cluster).
|
|
174
132
|
*
|
|
175
133
|
* @param request - The request {@link SetAclRulesRequest}
|
|
176
134
|
* @returns A Promise of SetAclRulesResponse
|
|
177
135
|
*/
|
|
178
136
|
setAclRules: (request: Readonly<SetAclRulesRequest>) => Promise<SetAclRulesResponse>;
|
|
179
137
|
/**
|
|
180
|
-
* Add ACL rules for a cluster. Add an additional ACL rule to a Redis™
|
|
181
|
-
* Database Instance (Redis™ cluster).
|
|
138
|
+
* Add ACL rules for a cluster. Add an additional ACL rule to a Redis™ Database Instance (Redis™ cluster).
|
|
182
139
|
*
|
|
183
140
|
* @param request - The request {@link AddAclRulesRequest}
|
|
184
141
|
* @returns A Promise of AddAclRulesResponse
|
|
185
142
|
*/
|
|
186
143
|
addAclRules: (request: Readonly<AddAclRulesRequest>) => Promise<AddAclRulesResponse>;
|
|
187
144
|
/**
|
|
188
|
-
* Delete an ACL rule for a cluster. Delete an ACL rule of a Redis™ Database
|
|
189
|
-
* Instance (Redis™ cluster). You must specify the `acl_id` of the rule you
|
|
190
|
-
* want to delete in your request.
|
|
145
|
+
* Delete an ACL rule for a cluster. Delete an ACL rule of a Redis™ Database Instance (Redis™ cluster). You must specify the `acl_id` of the rule you want to delete in your request.
|
|
191
146
|
*
|
|
192
147
|
* @param request - The request {@link DeleteAclRuleRequest}
|
|
193
148
|
* @returns A Promise of Cluster
|
|
194
149
|
*/
|
|
195
150
|
deleteAclRule: (request: Readonly<DeleteAclRuleRequest>) => Promise<Cluster>;
|
|
196
151
|
/**
|
|
197
|
-
* Get an ACL rule. Retrieve information about an ACL rule of a Redis™
|
|
198
|
-
* Database Instance (Redis™ cluster). You must specify the `acl_id` of the
|
|
199
|
-
* rule in your request.
|
|
152
|
+
* Get an ACL rule. Retrieve information about an ACL rule of a Redis™ Database Instance (Redis™ cluster). You must specify the `acl_id` of the rule in your request.
|
|
200
153
|
*
|
|
201
154
|
* @param request - The request {@link GetAclRuleRequest}
|
|
202
155
|
* @returns A Promise of ACLRule
|
|
203
156
|
*/
|
|
204
157
|
getAclRule: (request: Readonly<GetAclRuleRequest>) => Promise<ACLRule>;
|
|
205
158
|
/**
|
|
206
|
-
* Set endpoints for a cluster. Update an endpoint for a Redis™ Database
|
|
207
|
-
* Instance (Redis™ cluster). You must specify the `cluster_id` and the
|
|
208
|
-
* `endpoints` parameters in your request.
|
|
159
|
+
* Set endpoints for a cluster. Update an endpoint for a Redis™ Database Instance (Redis™ cluster). You must specify the `cluster_id` and the `endpoints` parameters in your request.
|
|
209
160
|
*
|
|
210
161
|
* @param request - The request {@link SetEndpointsRequest}
|
|
211
162
|
* @returns A Promise of SetEndpointsResponse
|
|
212
163
|
*/
|
|
213
164
|
setEndpoints: (request: Readonly<SetEndpointsRequest>) => Promise<SetEndpointsResponse>;
|
|
214
165
|
/**
|
|
215
|
-
* Add endpoints for a cluster. Add a new endpoint for a Redis™ Database
|
|
216
|
-
* Instance (Redis™ cluster). You can add `private_network` or
|
|
217
|
-
* `public_network` specifications to the body of the request.
|
|
166
|
+
* Add endpoints for a cluster. Add a new endpoint for a Redis™ Database Instance (Redis™ cluster). You can add `private_network` or `public_network` specifications to the body of the request.
|
|
218
167
|
*
|
|
219
168
|
* @param request - The request {@link AddEndpointsRequest}
|
|
220
169
|
* @returns A Promise of AddEndpointsResponse
|
|
221
170
|
*/
|
|
222
171
|
addEndpoints: (request: Readonly<AddEndpointsRequest>) => Promise<AddEndpointsResponse>;
|
|
223
172
|
/**
|
|
224
|
-
* Delete an endpoint for a cluster. Delete the endpoint of a Redis™ Database
|
|
225
|
-
* Instance (Redis™ cluster). You must specify the `region` and `endpoint_id`
|
|
226
|
-
* parameters of the endpoint you want to delete. Note that might need to
|
|
227
|
-
* update any environment configurations that point to the deleted endpoint.
|
|
173
|
+
* Delete an endpoint for a cluster. Delete the endpoint of a Redis™ Database Instance (Redis™ cluster). 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.
|
|
228
174
|
*
|
|
229
175
|
* @param request - The request {@link DeleteEndpointRequest}
|
|
230
176
|
* @returns A Promise of Cluster
|
|
231
177
|
*/
|
|
232
178
|
deleteEndpoint: (request: Readonly<DeleteEndpointRequest>) => Promise<Cluster>;
|
|
233
179
|
/**
|
|
234
|
-
* Get an endpoint. Retrieve information about a Redis™ Database Instance
|
|
235
|
-
* (Redis™ cluster) endpoint. Full details about the endpoint, like `ips`,
|
|
236
|
-
* `port`, `private_network` and `public_network` specifications are returned
|
|
237
|
-
* in the response.
|
|
180
|
+
* Get an endpoint. Retrieve information about a Redis™ Database Instance (Redis™ cluster) endpoint. Full details about the endpoint, like `ips`, `port`, `private_network` and `public_network` specifications are returned in the response.
|
|
238
181
|
*
|
|
239
182
|
* @param request - The request {@link GetEndpointRequest}
|
|
240
183
|
* @returns A Promise of Endpoint
|
|
241
184
|
*/
|
|
242
185
|
getEndpoint: (request: Readonly<GetEndpointRequest>) => Promise<Endpoint>;
|
|
243
186
|
/**
|
|
244
|
-
* Update an endpoint. Update information about a Redis™ Database Instance
|
|
245
|
-
* (Redis™ cluster) endpoint. Full details about the endpoint, like `ips`,
|
|
246
|
-
* `port`, `private_network` and `public_network` specifications are returned
|
|
247
|
-
* in the response.
|
|
187
|
+
* Update an endpoint. Update information about a Redis™ Database Instance (Redis™ cluster) endpoint. Full details about the endpoint, like `ips`, `port`, `private_network` and `public_network` specifications are returned in the response.
|
|
248
188
|
*
|
|
249
189
|
* @param request - The request {@link UpdateEndpointRequest}
|
|
250
190
|
* @returns A Promise of Endpoint
|