@scaleway/sdk 2.51.0 → 2.52.1
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/baremetal/v1/index.gen.d.ts +1 -1
- package/dist/api/baremetal/v1/marshalling.gen.cjs +12 -0
- package/dist/api/baremetal/v1/marshalling.gen.js +12 -0
- package/dist/api/baremetal/v1/types.gen.d.ts +8 -0
- package/dist/api/block/v1alpha1/api.gen.cjs +3 -0
- package/dist/api/block/v1alpha1/api.gen.js +3 -0
- package/dist/api/container/v1beta1/index.gen.d.ts +1 -1
- package/dist/api/container/v1beta1/marshalling.gen.cjs +21 -0
- package/dist/api/container/v1beta1/marshalling.gen.js +21 -0
- package/dist/api/container/v1beta1/types.gen.d.ts +30 -2
- package/dist/api/container/v1beta1/validation-rules.gen.cjs +2 -0
- package/dist/api/container/v1beta1/validation-rules.gen.d.ts +1 -0
- package/dist/api/container/v1beta1/validation-rules.gen.js +2 -0
- package/dist/api/edge_services/v1alpha1/marshalling.gen.cjs +1 -0
- package/dist/api/edge_services/v1alpha1/marshalling.gen.js +1 -0
- package/dist/api/edge_services/v1alpha1/types.gen.d.ts +2 -0
- package/dist/api/flexibleip/v1alpha1/api.gen.cjs +4 -1
- package/dist/api/flexibleip/v1alpha1/api.gen.js +4 -1
- package/dist/api/iam/v1alpha1/api.gen.cjs +11 -0
- package/dist/api/iam/v1alpha1/api.gen.d.ts +2 -1
- package/dist/api/iam/v1alpha1/api.gen.js +12 -1
- package/dist/api/iam/v1alpha1/index.gen.d.ts +1 -1
- package/dist/api/iam/v1alpha1/marshalling.gen.cjs +5 -0
- package/dist/api/iam/v1alpha1/marshalling.gen.d.ts +2 -1
- package/dist/api/iam/v1alpha1/marshalling.gen.js +5 -0
- package/dist/api/iam/v1alpha1/types.gen.d.ts +23 -18
- package/dist/api/iam/v1alpha1/validation-rules.gen.cjs +7 -0
- package/dist/api/iam/v1alpha1/validation-rules.gen.d.ts +6 -0
- package/dist/api/iam/v1alpha1/validation-rules.gen.js +8 -1
- package/dist/api/jobs/v1alpha1/api.gen.cjs +13 -0
- package/dist/api/jobs/v1alpha1/api.gen.d.ts +8 -1
- package/dist/api/jobs/v1alpha1/api.gen.js +14 -1
- package/dist/api/jobs/v1alpha1/index.gen.d.ts +1 -1
- package/dist/api/jobs/v1alpha1/marshalling.gen.cjs +11 -0
- package/dist/api/jobs/v1alpha1/marshalling.gen.d.ts +2 -1
- package/dist/api/jobs/v1alpha1/marshalling.gen.js +11 -0
- package/dist/api/jobs/v1alpha1/types.gen.d.ts +10 -0
- package/dist/api/k8s/v1/api.gen.cjs +0 -16
- package/dist/api/k8s/v1/api.gen.d.ts +1 -9
- package/dist/api/k8s/v1/api.gen.js +0 -16
- package/dist/api/k8s/v1/index.gen.d.ts +1 -1
- package/dist/api/k8s/v1/types.gen.d.ts +0 -9
- package/dist/api/k8s/v1/validation-rules.gen.cjs +8 -16
- package/dist/api/k8s/v1/validation-rules.gen.d.ts +0 -8
- package/dist/api/k8s/v1/validation-rules.gen.js +8 -16
- package/dist/api/mongodb/v1alpha1/api.gen.cjs +22 -15
- package/dist/api/mongodb/v1alpha1/api.gen.d.ts +24 -17
- package/dist/api/mongodb/v1alpha1/api.gen.js +22 -15
- package/dist/api/mongodb/v1alpha1/marshalling.gen.cjs +2 -1
- package/dist/api/mongodb/v1alpha1/marshalling.gen.js +2 -1
- package/dist/api/mongodb/v1alpha1/types.gen.d.ts +26 -26
- package/dist/scw/constants.cjs +1 -1
- package/dist/scw/constants.d.ts +2 -2
- package/dist/scw/constants.js +1 -1
- package/package.json +2 -2
|
@@ -226,5 +226,18 @@ class API extends api.API {
|
|
|
226
226
|
},
|
|
227
227
|
marshalling_gen.unmarshalListJobsResourcesResponse
|
|
228
228
|
);
|
|
229
|
+
/**
|
|
230
|
+
* Get jobs limits for the console.
|
|
231
|
+
*
|
|
232
|
+
* @param request - The request {@link GetJobsLimitsRequest}
|
|
233
|
+
* @returns A Promise of JobsLimits
|
|
234
|
+
*/
|
|
235
|
+
getJobsLimits = (request = {}) => this.client.fetch(
|
|
236
|
+
{
|
|
237
|
+
method: "GET",
|
|
238
|
+
path: `/serverless-jobs/v1alpha1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/jobs-limits`
|
|
239
|
+
},
|
|
240
|
+
marshalling_gen.unmarshalJobsLimits
|
|
241
|
+
);
|
|
229
242
|
}
|
|
230
243
|
exports.API = API;
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { API as ParentAPI } from '../../../bridge';
|
|
2
2
|
import type { Region } from '../../../bridge';
|
|
3
|
-
import type { CreateJobDefinitionRequest, CreateJobDefinitionSecretsRequest, CreateJobDefinitionSecretsResponse, DeleteJobDefinitionRequest, DeleteJobDefinitionSecretRequest, GetJobDefinitionRequest, GetJobDefinitionSecretRequest, GetJobRunRequest, JobDefinition, JobRun, ListJobDefinitionSecretsRequest, ListJobDefinitionSecretsResponse, ListJobDefinitionsRequest, ListJobDefinitionsResponse, ListJobRunsRequest, ListJobRunsResponse, ListJobsResourcesRequest, ListJobsResourcesResponse, Secret, StartJobDefinitionRequest, StartJobDefinitionResponse, StopJobRunRequest, UpdateJobDefinitionRequest, UpdateJobDefinitionSecretRequest } from './types.gen';
|
|
3
|
+
import type { CreateJobDefinitionRequest, CreateJobDefinitionSecretsRequest, CreateJobDefinitionSecretsResponse, DeleteJobDefinitionRequest, DeleteJobDefinitionSecretRequest, GetJobDefinitionRequest, GetJobDefinitionSecretRequest, GetJobRunRequest, GetJobsLimitsRequest, JobDefinition, JobRun, JobsLimits, ListJobDefinitionSecretsRequest, ListJobDefinitionSecretsResponse, ListJobDefinitionsRequest, ListJobDefinitionsResponse, ListJobRunsRequest, ListJobRunsResponse, ListJobsResourcesRequest, ListJobsResourcesResponse, Secret, StartJobDefinitionRequest, StartJobDefinitionResponse, StopJobRunRequest, UpdateJobDefinitionRequest, UpdateJobDefinitionSecretRequest } from './types.gen';
|
|
4
4
|
/**
|
|
5
5
|
* Serverless Jobs API.
|
|
6
6
|
*
|
|
@@ -93,4 +93,11 @@ export declare class API extends ParentAPI {
|
|
|
93
93
|
* @returns A Promise of ListJobsResourcesResponse
|
|
94
94
|
*/
|
|
95
95
|
listJobsResources: (request?: Readonly<ListJobsResourcesRequest>) => Promise<ListJobsResourcesResponse>;
|
|
96
|
+
/**
|
|
97
|
+
* Get jobs limits for the console.
|
|
98
|
+
*
|
|
99
|
+
* @param request - The request {@link GetJobsLimitsRequest}
|
|
100
|
+
* @returns A Promise of JobsLimits
|
|
101
|
+
*/
|
|
102
|
+
getJobsLimits: (request?: Readonly<GetJobsLimitsRequest>) => Promise<JobsLimits>;
|
|
96
103
|
}
|
|
@@ -2,7 +2,7 @@ import { API as API$1 } from "../../../scw/api.js";
|
|
|
2
2
|
import { validatePathParam, urlParams } from "../../../helpers/marshalling.js";
|
|
3
3
|
import "../../../vendor/base64/index.js";
|
|
4
4
|
import { enrichForPagination } from "../../../scw/fetch/resource-paginator.js";
|
|
5
|
-
import { marshalCreateJobDefinitionRequest, unmarshalJobDefinition, unmarshalListJobDefinitionsResponse, marshalUpdateJobDefinitionRequest, marshalStartJobDefinitionRequest, unmarshalStartJobDefinitionResponse, marshalCreateJobDefinitionSecretsRequest, unmarshalCreateJobDefinitionSecretsResponse, unmarshalSecret, unmarshalListJobDefinitionSecretsResponse, marshalUpdateJobDefinitionSecretRequest, unmarshalJobRun, unmarshalListJobRunsResponse, unmarshalListJobsResourcesResponse } from "./marshalling.gen.js";
|
|
5
|
+
import { marshalCreateJobDefinitionRequest, unmarshalJobDefinition, unmarshalListJobDefinitionsResponse, marshalUpdateJobDefinitionRequest, marshalStartJobDefinitionRequest, unmarshalStartJobDefinitionResponse, marshalCreateJobDefinitionSecretsRequest, unmarshalCreateJobDefinitionSecretsResponse, unmarshalSecret, unmarshalListJobDefinitionSecretsResponse, marshalUpdateJobDefinitionSecretRequest, unmarshalJobRun, unmarshalListJobRunsResponse, unmarshalListJobsResourcesResponse, unmarshalJobsLimits } from "./marshalling.gen.js";
|
|
6
6
|
const jsonContentHeaders = {
|
|
7
7
|
"Content-Type": "application/json; charset=utf-8"
|
|
8
8
|
};
|
|
@@ -224,6 +224,19 @@ class API extends API$1 {
|
|
|
224
224
|
},
|
|
225
225
|
unmarshalListJobsResourcesResponse
|
|
226
226
|
);
|
|
227
|
+
/**
|
|
228
|
+
* Get jobs limits for the console.
|
|
229
|
+
*
|
|
230
|
+
* @param request - The request {@link GetJobsLimitsRequest}
|
|
231
|
+
* @returns A Promise of JobsLimits
|
|
232
|
+
*/
|
|
233
|
+
getJobsLimits = (request = {}) => this.client.fetch(
|
|
234
|
+
{
|
|
235
|
+
method: "GET",
|
|
236
|
+
path: `/serverless-jobs/v1alpha1/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/jobs-limits`
|
|
237
|
+
},
|
|
238
|
+
unmarshalJobsLimits
|
|
239
|
+
);
|
|
227
240
|
}
|
|
228
241
|
export {
|
|
229
242
|
API
|
|
@@ -1,4 +1,4 @@
|
|
|
1
1
|
export { API } from './api.gen';
|
|
2
2
|
export * from './content.gen';
|
|
3
|
-
export type { CreateJobDefinitionRequest, CreateJobDefinitionRequestCronScheduleConfig, CreateJobDefinitionSecretsRequest, CreateJobDefinitionSecretsRequestSecretConfig, CreateJobDefinitionSecretsResponse, CronSchedule, DeleteJobDefinitionRequest, DeleteJobDefinitionSecretRequest, GetJobDefinitionRequest, GetJobDefinitionSecretRequest, GetJobRunRequest, JobDefinition, JobRun, JobRunState, ListJobDefinitionSecretsRequest, ListJobDefinitionSecretsResponse, ListJobDefinitionsRequest, ListJobDefinitionsRequestOrderBy, ListJobDefinitionsResponse, ListJobRunsRequest, ListJobRunsRequestOrderBy, ListJobRunsResponse, ListJobsResourcesRequest, ListJobsResourcesResponse, Resource, Secret, SecretEnvVar, SecretFile, StartJobDefinitionRequest, StartJobDefinitionResponse, StopJobRunRequest, UpdateJobDefinitionRequest, UpdateJobDefinitionRequestCronScheduleConfig, UpdateJobDefinitionSecretRequest, } from './types.gen';
|
|
3
|
+
export type { CreateJobDefinitionRequest, CreateJobDefinitionRequestCronScheduleConfig, CreateJobDefinitionSecretsRequest, CreateJobDefinitionSecretsRequestSecretConfig, CreateJobDefinitionSecretsResponse, CronSchedule, DeleteJobDefinitionRequest, DeleteJobDefinitionSecretRequest, GetJobDefinitionRequest, GetJobDefinitionSecretRequest, GetJobRunRequest, GetJobsLimitsRequest, JobDefinition, JobRun, JobRunState, JobsLimits, ListJobDefinitionSecretsRequest, ListJobDefinitionSecretsResponse, ListJobDefinitionsRequest, ListJobDefinitionsRequestOrderBy, ListJobDefinitionsResponse, ListJobRunsRequest, ListJobRunsRequestOrderBy, ListJobRunsResponse, ListJobsResourcesRequest, ListJobsResourcesResponse, Resource, Secret, SecretEnvVar, SecretFile, StartJobDefinitionRequest, StartJobDefinitionResponse, StopJobRunRequest, UpdateJobDefinitionRequest, UpdateJobDefinitionRequestCronScheduleConfig, UpdateJobDefinitionSecretRequest, } from './types.gen';
|
|
4
4
|
export * as ValidationRules from './validation-rules.gen';
|
|
@@ -108,6 +108,16 @@ const unmarshalCreateJobDefinitionSecretsResponse = (data) => {
|
|
|
108
108
|
secrets: marshalling.unmarshalArrayOfObject(data.secrets, unmarshalSecret)
|
|
109
109
|
};
|
|
110
110
|
};
|
|
111
|
+
const unmarshalJobsLimits = (data) => {
|
|
112
|
+
if (!json.isJSONObject(data)) {
|
|
113
|
+
throw new TypeError(
|
|
114
|
+
`Unmarshalling the type 'JobsLimits' failed as data isn't a dictionary.`
|
|
115
|
+
);
|
|
116
|
+
}
|
|
117
|
+
return {
|
|
118
|
+
secretsPerJobDefinition: data.secrets_per_job_definition
|
|
119
|
+
};
|
|
120
|
+
};
|
|
111
121
|
const unmarshalListJobDefinitionSecretsResponse = (data) => {
|
|
112
122
|
if (!json.isJSONObject(data)) {
|
|
113
123
|
throw new TypeError(
|
|
@@ -245,6 +255,7 @@ exports.marshalUpdateJobDefinitionSecretRequest = marshalUpdateJobDefinitionSecr
|
|
|
245
255
|
exports.unmarshalCreateJobDefinitionSecretsResponse = unmarshalCreateJobDefinitionSecretsResponse;
|
|
246
256
|
exports.unmarshalJobDefinition = unmarshalJobDefinition;
|
|
247
257
|
exports.unmarshalJobRun = unmarshalJobRun;
|
|
258
|
+
exports.unmarshalJobsLimits = unmarshalJobsLimits;
|
|
248
259
|
exports.unmarshalListJobDefinitionSecretsResponse = unmarshalListJobDefinitionSecretsResponse;
|
|
249
260
|
exports.unmarshalListJobDefinitionsResponse = unmarshalListJobDefinitionsResponse;
|
|
250
261
|
exports.unmarshalListJobRunsResponse = unmarshalListJobRunsResponse;
|
|
@@ -1,9 +1,10 @@
|
|
|
1
1
|
import type { DefaultValues } from '../../../bridge';
|
|
2
|
-
import type { CreateJobDefinitionRequest, CreateJobDefinitionSecretsRequest, CreateJobDefinitionSecretsResponse, JobDefinition, JobRun, ListJobDefinitionSecretsResponse, ListJobDefinitionsResponse, ListJobRunsResponse, ListJobsResourcesResponse, Secret, StartJobDefinitionRequest, StartJobDefinitionResponse, UpdateJobDefinitionRequest, UpdateJobDefinitionSecretRequest } from './types.gen';
|
|
2
|
+
import type { CreateJobDefinitionRequest, CreateJobDefinitionSecretsRequest, CreateJobDefinitionSecretsResponse, JobDefinition, JobRun, JobsLimits, ListJobDefinitionSecretsResponse, ListJobDefinitionsResponse, ListJobRunsResponse, ListJobsResourcesResponse, Secret, StartJobDefinitionRequest, StartJobDefinitionResponse, UpdateJobDefinitionRequest, UpdateJobDefinitionSecretRequest } from './types.gen';
|
|
3
3
|
export declare const unmarshalSecret: (data: unknown) => Secret;
|
|
4
4
|
export declare const unmarshalJobDefinition: (data: unknown) => JobDefinition;
|
|
5
5
|
export declare const unmarshalJobRun: (data: unknown) => JobRun;
|
|
6
6
|
export declare const unmarshalCreateJobDefinitionSecretsResponse: (data: unknown) => CreateJobDefinitionSecretsResponse;
|
|
7
|
+
export declare const unmarshalJobsLimits: (data: unknown) => JobsLimits;
|
|
7
8
|
export declare const unmarshalListJobDefinitionSecretsResponse: (data: unknown) => ListJobDefinitionSecretsResponse;
|
|
8
9
|
export declare const unmarshalListJobDefinitionsResponse: (data: unknown) => ListJobDefinitionsResponse;
|
|
9
10
|
export declare const unmarshalListJobRunsResponse: (data: unknown) => ListJobRunsResponse;
|
|
@@ -106,6 +106,16 @@ const unmarshalCreateJobDefinitionSecretsResponse = (data) => {
|
|
|
106
106
|
secrets: unmarshalArrayOfObject(data.secrets, unmarshalSecret)
|
|
107
107
|
};
|
|
108
108
|
};
|
|
109
|
+
const unmarshalJobsLimits = (data) => {
|
|
110
|
+
if (!isJSONObject(data)) {
|
|
111
|
+
throw new TypeError(
|
|
112
|
+
`Unmarshalling the type 'JobsLimits' failed as data isn't a dictionary.`
|
|
113
|
+
);
|
|
114
|
+
}
|
|
115
|
+
return {
|
|
116
|
+
secretsPerJobDefinition: data.secrets_per_job_definition
|
|
117
|
+
};
|
|
118
|
+
};
|
|
109
119
|
const unmarshalListJobDefinitionSecretsResponse = (data) => {
|
|
110
120
|
if (!isJSONObject(data)) {
|
|
111
121
|
throw new TypeError(
|
|
@@ -244,6 +254,7 @@ export {
|
|
|
244
254
|
unmarshalCreateJobDefinitionSecretsResponse,
|
|
245
255
|
unmarshalJobDefinition,
|
|
246
256
|
unmarshalJobRun,
|
|
257
|
+
unmarshalJobsLimits,
|
|
247
258
|
unmarshalListJobDefinitionSecretsResponse,
|
|
248
259
|
unmarshalListJobDefinitionsResponse,
|
|
249
260
|
unmarshalListJobRunsResponse,
|
|
@@ -180,6 +180,16 @@ export type GetJobRunRequest = {
|
|
|
180
180
|
/** UUID of the job run to get. */
|
|
181
181
|
jobRunId: string;
|
|
182
182
|
};
|
|
183
|
+
export type GetJobsLimitsRequest = {
|
|
184
|
+
/**
|
|
185
|
+
* Region to target. If none is passed will use default region from the
|
|
186
|
+
* config.
|
|
187
|
+
*/
|
|
188
|
+
region?: Region;
|
|
189
|
+
};
|
|
190
|
+
export interface JobsLimits {
|
|
191
|
+
secretsPerJobDefinition: number;
|
|
192
|
+
}
|
|
183
193
|
export type ListJobDefinitionSecretsRequest = {
|
|
184
194
|
/**
|
|
185
195
|
* Region to target. If none is passed will use default region from the
|
|
@@ -211,22 +211,6 @@ class API extends api.API {
|
|
|
211
211
|
method: "POST",
|
|
212
212
|
path: `/k8s/v1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/clusters/${marshalling.validatePathParam("clusterId", request.clusterId)}/reset-admin-token`
|
|
213
213
|
});
|
|
214
|
-
/**
|
|
215
|
-
* Migrate a cluster to Routed IPs. Migrate the nodes of an existing cluster
|
|
216
|
-
* to Routed IPs and enable Routed IPs for all future nodes.
|
|
217
|
-
*
|
|
218
|
-
* @param request - The request {@link MigrateClusterToRoutedIPsRequest}
|
|
219
|
-
* @returns A Promise of Cluster
|
|
220
|
-
*/
|
|
221
|
-
migrateClusterToRoutedIPs = (request) => this.client.fetch(
|
|
222
|
-
{
|
|
223
|
-
body: "{}",
|
|
224
|
-
headers: jsonContentHeaders,
|
|
225
|
-
method: "POST",
|
|
226
|
-
path: `/k8s/v1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/clusters/${marshalling.validatePathParam("clusterId", request.clusterId)}/migrate-to-routed-ips`
|
|
227
|
-
},
|
|
228
|
-
marshalling_gen.unmarshalCluster
|
|
229
|
-
);
|
|
230
214
|
/**
|
|
231
215
|
* Migrate a cluster to SBS CSI. Enable the latest CSI compatible with
|
|
232
216
|
* Scaleway Block Storage (SBS) and migrate all existing
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { API as ParentAPI } from '../../../bridge';
|
|
2
2
|
import type { Region, WaitForOptions } from '../../../bridge';
|
|
3
|
-
import type { AuthExternalNodeRequest, Cluster, CreateClusterRequest, CreateExternalNodeRequest, CreatePoolRequest, DeleteClusterRequest, DeleteNodeRequest, DeletePoolRequest, ExternalNode, ExternalNodeAuth, GetClusterKubeConfigRequest, GetClusterRequest, GetNodeMetadataRequest, GetNodeRequest, GetPoolRequest, GetVersionRequest, ListClusterAvailableTypesRequest, ListClusterAvailableTypesResponse, ListClusterAvailableVersionsRequest, ListClusterAvailableVersionsResponse, ListClusterTypesRequest, ListClusterTypesResponse, ListClustersRequest, ListClustersResponse, ListNodesRequest, ListNodesResponse, ListPoolsRequest, ListPoolsResponse, ListVersionsRequest, ListVersionsResponse,
|
|
3
|
+
import type { AuthExternalNodeRequest, Cluster, CreateClusterRequest, CreateExternalNodeRequest, CreatePoolRequest, DeleteClusterRequest, DeleteNodeRequest, DeletePoolRequest, ExternalNode, ExternalNodeAuth, GetClusterKubeConfigRequest, GetClusterRequest, GetNodeMetadataRequest, GetNodeRequest, GetPoolRequest, GetVersionRequest, ListClusterAvailableTypesRequest, ListClusterAvailableTypesResponse, ListClusterAvailableVersionsRequest, ListClusterAvailableVersionsResponse, ListClusterTypesRequest, ListClusterTypesResponse, ListClustersRequest, ListClustersResponse, ListNodesRequest, ListNodesResponse, ListPoolsRequest, ListPoolsResponse, ListVersionsRequest, ListVersionsResponse, MigrateClusterToSBSCSIRequest, Node, NodeMetadata, Pool, RebootNodeRequest, ReplaceNodeRequest, ResetClusterAdminTokenRequest, SetClusterTypeRequest, UpdateClusterRequest, UpdatePoolRequest, UpgradeClusterRequest, UpgradePoolRequest, Version } from './types.gen';
|
|
4
4
|
/**
|
|
5
5
|
* Kubernetes API.
|
|
6
6
|
*
|
|
@@ -107,14 +107,6 @@ export declare class API extends ParentAPI {
|
|
|
107
107
|
* @param request - The request {@link ResetClusterAdminTokenRequest}
|
|
108
108
|
*/
|
|
109
109
|
resetClusterAdminToken: (request: Readonly<ResetClusterAdminTokenRequest>) => Promise<void>;
|
|
110
|
-
/**
|
|
111
|
-
* Migrate a cluster to Routed IPs. Migrate the nodes of an existing cluster
|
|
112
|
-
* to Routed IPs and enable Routed IPs for all future nodes.
|
|
113
|
-
*
|
|
114
|
-
* @param request - The request {@link MigrateClusterToRoutedIPsRequest}
|
|
115
|
-
* @returns A Promise of Cluster
|
|
116
|
-
*/
|
|
117
|
-
migrateClusterToRoutedIPs: (request: Readonly<MigrateClusterToRoutedIPsRequest>) => Promise<Cluster>;
|
|
118
110
|
/**
|
|
119
111
|
* Migrate a cluster to SBS CSI. Enable the latest CSI compatible with
|
|
120
112
|
* Scaleway Block Storage (SBS) and migrate all existing
|
|
@@ -209,22 +209,6 @@ class API extends API$1 {
|
|
|
209
209
|
method: "POST",
|
|
210
210
|
path: `/k8s/v1/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/clusters/${validatePathParam("clusterId", request.clusterId)}/reset-admin-token`
|
|
211
211
|
});
|
|
212
|
-
/**
|
|
213
|
-
* Migrate a cluster to Routed IPs. Migrate the nodes of an existing cluster
|
|
214
|
-
* to Routed IPs and enable Routed IPs for all future nodes.
|
|
215
|
-
*
|
|
216
|
-
* @param request - The request {@link MigrateClusterToRoutedIPsRequest}
|
|
217
|
-
* @returns A Promise of Cluster
|
|
218
|
-
*/
|
|
219
|
-
migrateClusterToRoutedIPs = (request) => this.client.fetch(
|
|
220
|
-
{
|
|
221
|
-
body: "{}",
|
|
222
|
-
headers: jsonContentHeaders,
|
|
223
|
-
method: "POST",
|
|
224
|
-
path: `/k8s/v1/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/clusters/${validatePathParam("clusterId", request.clusterId)}/migrate-to-routed-ips`
|
|
225
|
-
},
|
|
226
|
-
unmarshalCluster
|
|
227
|
-
);
|
|
228
212
|
/**
|
|
229
213
|
* Migrate a cluster to SBS CSI. Enable the latest CSI compatible with
|
|
230
214
|
* Scaleway Block Storage (SBS) and migrate all existing
|
|
@@ -1,4 +1,4 @@
|
|
|
1
1
|
export { API } from './api.gen';
|
|
2
2
|
export * from './content.gen';
|
|
3
|
-
export type { AuthExternalNodeRequest, AutoscalerEstimator, AutoscalerExpander, CNI, Cluster, ClusterAutoUpgrade, ClusterAutoscalerConfig, ClusterOpenIDConnectConfig, ClusterStatus, ClusterType, ClusterTypeAvailability, ClusterTypeResiliency, CreateClusterRequest, CreateClusterRequestAutoUpgrade, CreateClusterRequestAutoscalerConfig, CreateClusterRequestOpenIDConnectConfig, CreateClusterRequestPoolConfig, CreateClusterRequestPoolConfigUpgradePolicy, CreateExternalNodeRequest, CreatePoolRequest, CreatePoolRequestUpgradePolicy, DeleteClusterRequest, DeleteNodeRequest, DeletePoolRequest, ExternalNode, ExternalNodeAuth, ExternalNodeCoreV1Taint, GetClusterKubeConfigRequest, GetClusterRequest, GetNodeMetadataRequest, GetNodeRequest, GetPoolRequest, GetVersionRequest, ListClusterAvailableTypesRequest, ListClusterAvailableTypesResponse, ListClusterAvailableVersionsRequest, ListClusterAvailableVersionsResponse, ListClusterTypesRequest, ListClusterTypesResponse, ListClustersRequest, ListClustersRequestOrderBy, ListClustersResponse, ListNodesRequest, ListNodesRequestOrderBy, ListNodesResponse, ListPoolsRequest, ListPoolsRequestOrderBy, ListPoolsResponse, ListVersionsRequest, ListVersionsResponse, MaintenanceWindow, MaintenanceWindowDayOfTheWeek,
|
|
3
|
+
export type { AuthExternalNodeRequest, AutoscalerEstimator, AutoscalerExpander, CNI, Cluster, ClusterAutoUpgrade, ClusterAutoscalerConfig, ClusterOpenIDConnectConfig, ClusterStatus, ClusterType, ClusterTypeAvailability, ClusterTypeResiliency, CreateClusterRequest, CreateClusterRequestAutoUpgrade, CreateClusterRequestAutoscalerConfig, CreateClusterRequestOpenIDConnectConfig, CreateClusterRequestPoolConfig, CreateClusterRequestPoolConfigUpgradePolicy, CreateExternalNodeRequest, CreatePoolRequest, CreatePoolRequestUpgradePolicy, DeleteClusterRequest, DeleteNodeRequest, DeletePoolRequest, ExternalNode, ExternalNodeAuth, ExternalNodeCoreV1Taint, GetClusterKubeConfigRequest, GetClusterRequest, GetNodeMetadataRequest, GetNodeRequest, GetPoolRequest, GetVersionRequest, ListClusterAvailableTypesRequest, ListClusterAvailableTypesResponse, ListClusterAvailableVersionsRequest, ListClusterAvailableVersionsResponse, ListClusterTypesRequest, ListClusterTypesResponse, ListClustersRequest, ListClustersRequestOrderBy, ListClustersResponse, ListNodesRequest, ListNodesRequestOrderBy, ListNodesResponse, ListPoolsRequest, ListPoolsRequestOrderBy, ListPoolsResponse, ListVersionsRequest, ListVersionsResponse, MaintenanceWindow, MaintenanceWindowDayOfTheWeek, MigrateClusterToSBSCSIRequest, Node, NodeMetadata, NodeMetadataCoreV1Taint, NodeStatus, Pool, PoolStatus, PoolUpgradePolicy, PoolVolumeType, RebootNodeRequest, ReplaceNodeRequest, ResetClusterAdminTokenRequest, Runtime, SetClusterTypeRequest, UpdateClusterRequest, UpdateClusterRequestAutoUpgrade, UpdateClusterRequestAutoscalerConfig, UpdateClusterRequestOpenIDConnectConfig, UpdatePoolRequest, UpdatePoolRequestUpgradePolicy, UpgradeClusterRequest, UpgradePoolRequest, Version, } from './types.gen';
|
|
4
4
|
export * as ValidationRules from './validation-rules.gen';
|
|
@@ -1000,15 +1000,6 @@ export interface ListVersionsResponse {
|
|
|
1000
1000
|
/** Available Kubernetes versions. */
|
|
1001
1001
|
versions: Version[];
|
|
1002
1002
|
}
|
|
1003
|
-
export type MigrateClusterToRoutedIPsRequest = {
|
|
1004
|
-
/**
|
|
1005
|
-
* Region to target. If none is passed will use default region from the
|
|
1006
|
-
* config.
|
|
1007
|
-
*/
|
|
1008
|
-
region?: Region;
|
|
1009
|
-
/** Cluster ID for which the routed ip will be enabled for the nodes. */
|
|
1010
|
-
clusterId: string;
|
|
1011
|
-
};
|
|
1012
1003
|
export type MigrateClusterToSBSCSIRequest = {
|
|
1013
1004
|
/**
|
|
1014
1005
|
* Region to target. If none is passed will use default region from the
|
|
@@ -26,23 +26,19 @@ const CreateClusterRequestAutoscalerConfig = {
|
|
|
26
26
|
};
|
|
27
27
|
const CreateClusterRequestOpenIDConnectConfig = {
|
|
28
28
|
clientId: {
|
|
29
|
-
maxLength: 255
|
|
30
|
-
minLength: 1
|
|
29
|
+
maxLength: 255
|
|
31
30
|
},
|
|
32
31
|
groupsPrefix: {
|
|
33
|
-
maxLength: 100
|
|
34
|
-
minLength: 1
|
|
32
|
+
maxLength: 100
|
|
35
33
|
},
|
|
36
34
|
issuerUrl: {
|
|
37
35
|
maxLength: 255
|
|
38
36
|
},
|
|
39
37
|
usernameClaim: {
|
|
40
|
-
maxLength: 100
|
|
41
|
-
minLength: 1
|
|
38
|
+
maxLength: 100
|
|
42
39
|
},
|
|
43
40
|
usernamePrefix: {
|
|
44
|
-
maxLength: 100
|
|
45
|
-
minLength: 1
|
|
41
|
+
maxLength: 100
|
|
46
42
|
}
|
|
47
43
|
};
|
|
48
44
|
const CreateClusterRequestPoolConfig = {
|
|
@@ -132,23 +128,19 @@ const UpdateClusterRequestAutoscalerConfig = {
|
|
|
132
128
|
};
|
|
133
129
|
const UpdateClusterRequestOpenIDConnectConfig = {
|
|
134
130
|
clientId: {
|
|
135
|
-
maxLength: 255
|
|
136
|
-
minLength: 1
|
|
131
|
+
maxLength: 255
|
|
137
132
|
},
|
|
138
133
|
groupsPrefix: {
|
|
139
|
-
maxLength: 100
|
|
140
|
-
minLength: 1
|
|
134
|
+
maxLength: 100
|
|
141
135
|
},
|
|
142
136
|
issuerUrl: {
|
|
143
137
|
maxLength: 255
|
|
144
138
|
},
|
|
145
139
|
usernameClaim: {
|
|
146
|
-
maxLength: 100
|
|
147
|
-
minLength: 1
|
|
140
|
+
maxLength: 100
|
|
148
141
|
},
|
|
149
142
|
usernamePrefix: {
|
|
150
|
-
maxLength: 100
|
|
151
|
-
minLength: 1
|
|
143
|
+
maxLength: 100
|
|
152
144
|
}
|
|
153
145
|
};
|
|
154
146
|
const UpgradeClusterRequest = {
|
|
@@ -25,22 +25,18 @@ export declare const CreateClusterRequestAutoscalerConfig: {
|
|
|
25
25
|
export declare const CreateClusterRequestOpenIDConnectConfig: {
|
|
26
26
|
clientId: {
|
|
27
27
|
maxLength: number;
|
|
28
|
-
minLength: number;
|
|
29
28
|
};
|
|
30
29
|
groupsPrefix: {
|
|
31
30
|
maxLength: number;
|
|
32
|
-
minLength: number;
|
|
33
31
|
};
|
|
34
32
|
issuerUrl: {
|
|
35
33
|
maxLength: number;
|
|
36
34
|
};
|
|
37
35
|
usernameClaim: {
|
|
38
36
|
maxLength: number;
|
|
39
|
-
minLength: number;
|
|
40
37
|
};
|
|
41
38
|
usernamePrefix: {
|
|
42
39
|
maxLength: number;
|
|
43
|
-
minLength: number;
|
|
44
40
|
};
|
|
45
41
|
};
|
|
46
42
|
export declare const CreateClusterRequestPoolConfig: {
|
|
@@ -131,22 +127,18 @@ export declare const UpdateClusterRequestAutoscalerConfig: {
|
|
|
131
127
|
export declare const UpdateClusterRequestOpenIDConnectConfig: {
|
|
132
128
|
clientId: {
|
|
133
129
|
maxLength: number;
|
|
134
|
-
minLength: number;
|
|
135
130
|
};
|
|
136
131
|
groupsPrefix: {
|
|
137
132
|
maxLength: number;
|
|
138
|
-
minLength: number;
|
|
139
133
|
};
|
|
140
134
|
issuerUrl: {
|
|
141
135
|
maxLength: number;
|
|
142
136
|
};
|
|
143
137
|
usernameClaim: {
|
|
144
138
|
maxLength: number;
|
|
145
|
-
minLength: number;
|
|
146
139
|
};
|
|
147
140
|
usernamePrefix: {
|
|
148
141
|
maxLength: number;
|
|
149
|
-
minLength: number;
|
|
150
142
|
};
|
|
151
143
|
};
|
|
152
144
|
export declare const UpgradeClusterRequest: {
|
|
@@ -24,23 +24,19 @@ const CreateClusterRequestAutoscalerConfig = {
|
|
|
24
24
|
};
|
|
25
25
|
const CreateClusterRequestOpenIDConnectConfig = {
|
|
26
26
|
clientId: {
|
|
27
|
-
maxLength: 255
|
|
28
|
-
minLength: 1
|
|
27
|
+
maxLength: 255
|
|
29
28
|
},
|
|
30
29
|
groupsPrefix: {
|
|
31
|
-
maxLength: 100
|
|
32
|
-
minLength: 1
|
|
30
|
+
maxLength: 100
|
|
33
31
|
},
|
|
34
32
|
issuerUrl: {
|
|
35
33
|
maxLength: 255
|
|
36
34
|
},
|
|
37
35
|
usernameClaim: {
|
|
38
|
-
maxLength: 100
|
|
39
|
-
minLength: 1
|
|
36
|
+
maxLength: 100
|
|
40
37
|
},
|
|
41
38
|
usernamePrefix: {
|
|
42
|
-
maxLength: 100
|
|
43
|
-
minLength: 1
|
|
39
|
+
maxLength: 100
|
|
44
40
|
}
|
|
45
41
|
};
|
|
46
42
|
const CreateClusterRequestPoolConfig = {
|
|
@@ -130,23 +126,19 @@ const UpdateClusterRequestAutoscalerConfig = {
|
|
|
130
126
|
};
|
|
131
127
|
const UpdateClusterRequestOpenIDConnectConfig = {
|
|
132
128
|
clientId: {
|
|
133
|
-
maxLength: 255
|
|
134
|
-
minLength: 1
|
|
129
|
+
maxLength: 255
|
|
135
130
|
},
|
|
136
131
|
groupsPrefix: {
|
|
137
|
-
maxLength: 100
|
|
138
|
-
minLength: 1
|
|
132
|
+
maxLength: 100
|
|
139
133
|
},
|
|
140
134
|
issuerUrl: {
|
|
141
135
|
maxLength: 255
|
|
142
136
|
},
|
|
143
137
|
usernameClaim: {
|
|
144
|
-
maxLength: 100
|
|
145
|
-
minLength: 1
|
|
138
|
+
maxLength: 100
|
|
146
139
|
},
|
|
147
140
|
usernamePrefix: {
|
|
148
|
-
maxLength: 100
|
|
149
|
-
minLength: 1
|
|
141
|
+
maxLength: 100
|
|
150
142
|
}
|
|
151
143
|
};
|
|
152
144
|
const UpgradeClusterRequest = {
|
|
@@ -51,7 +51,7 @@ class API extends api.API {
|
|
|
51
51
|
marshalling_gen.unmarshalListVersionsResponse
|
|
52
52
|
);
|
|
53
53
|
/**
|
|
54
|
-
* List available MongoDB
|
|
54
|
+
* List available MongoDB® versions.
|
|
55
55
|
*
|
|
56
56
|
* @param request - The request {@link ListVersionsRequest}
|
|
57
57
|
* @returns A Promise of ListVersionsResponse
|
|
@@ -83,22 +83,21 @@ class API extends api.API {
|
|
|
83
83
|
marshalling_gen.unmarshalListInstancesResponse
|
|
84
84
|
);
|
|
85
85
|
/**
|
|
86
|
-
* List MongoDB
|
|
87
|
-
* the specified region
|
|
88
|
-
*
|
|
89
|
-
*
|
|
90
|
-
*
|
|
91
|
-
*
|
|
92
|
-
*
|
|
93
|
-
* the parameter.
|
|
86
|
+
* List MongoDB® Database Instances. List all MongoDB® Database Instances in
|
|
87
|
+
* the specified region. By default, the MongoDB® Database Instances returned
|
|
88
|
+
* in the list are ordered by creation date in ascending order, though this
|
|
89
|
+
* can be modified via the order_by field. You can define additional
|
|
90
|
+
* parameters for your query, such as `tags` and `name`. For the `name`
|
|
91
|
+
* parameter, the value you include will be checked against the whole name
|
|
92
|
+
* string to see if it includes the string you put in the parameter.
|
|
94
93
|
*
|
|
95
94
|
* @param request - The request {@link ListInstancesRequest}
|
|
96
95
|
* @returns A Promise of ListInstancesResponse
|
|
97
96
|
*/
|
|
98
97
|
listInstances = (request = {}) => resourcePaginator.enrichForPagination("instances", this.pageOfListInstances, request);
|
|
99
98
|
/**
|
|
100
|
-
* Get a MongoDB
|
|
101
|
-
* MongoDB
|
|
99
|
+
* Get a MongoDB® Database Instance. Retrieve information about a given
|
|
100
|
+
* MongoDB® Database Instance, specified by the `region` and `instance_id`
|
|
102
101
|
* parameters. Its full details, including name, status, IP address and port,
|
|
103
102
|
* are returned in the response object.
|
|
104
103
|
*
|
|
@@ -126,7 +125,7 @@ class API extends api.API {
|
|
|
126
125
|
options
|
|
127
126
|
);
|
|
128
127
|
/**
|
|
129
|
-
* Create a MongoDB
|
|
128
|
+
* Create a MongoDB® Database Instance. Create a new MongoDB® Database
|
|
130
129
|
* Instance.
|
|
131
130
|
*
|
|
132
131
|
* @param request - The request {@link CreateInstanceRequest}
|
|
@@ -144,7 +143,7 @@ class API extends api.API {
|
|
|
144
143
|
marshalling_gen.unmarshalInstance
|
|
145
144
|
);
|
|
146
145
|
/**
|
|
147
|
-
* Update a MongoDB
|
|
146
|
+
* Update a MongoDB® Database Instance. Update the parameters of a MongoDB®
|
|
148
147
|
* Database Instance.
|
|
149
148
|
*
|
|
150
149
|
* @param request - The request {@link UpdateInstanceRequest}
|
|
@@ -162,9 +161,9 @@ class API extends api.API {
|
|
|
162
161
|
marshalling_gen.unmarshalInstance
|
|
163
162
|
);
|
|
164
163
|
/**
|
|
165
|
-
* Delete a MongoDB
|
|
164
|
+
* Delete a MongoDB® Database Instance. Delete a given MongoDB® Database
|
|
166
165
|
* Instance, specified by the `region` and `instance_id` parameters. Deleting
|
|
167
|
-
* a MongoDB
|
|
166
|
+
* a MongoDB® Database Instance is permanent, and cannot be undone. Note that
|
|
168
167
|
* upon deletion all your data will be lost.
|
|
169
168
|
*
|
|
170
169
|
* @param request - The request {@link DeleteInstanceRequest}
|
|
@@ -255,6 +254,14 @@ class API extends api.API {
|
|
|
255
254
|
request,
|
|
256
255
|
options
|
|
257
256
|
);
|
|
257
|
+
/**
|
|
258
|
+
* Update a Database Instance snapshot. Update the parameters of a snapshot of
|
|
259
|
+
* a Database Instance. You can update the `name` and `expires_at`
|
|
260
|
+
* parameters.
|
|
261
|
+
*
|
|
262
|
+
* @param request - The request {@link UpdateSnapshotRequest}
|
|
263
|
+
* @returns A Promise of Snapshot
|
|
264
|
+
*/
|
|
258
265
|
updateSnapshot = (request) => this.client.fetch(
|
|
259
266
|
{
|
|
260
267
|
body: JSON.stringify(
|
|
@@ -2,9 +2,9 @@ import { API as ParentAPI } from '../../../bridge';
|
|
|
2
2
|
import type { Region, WaitForOptions } from '../../../bridge';
|
|
3
3
|
import type { CreateInstanceRequest, CreateSnapshotRequest, DeleteInstanceRequest, DeleteSnapshotRequest, GetInstanceCertificateRequest, GetInstanceRequest, GetSnapshotRequest, Instance, ListInstancesRequest, ListInstancesResponse, ListNodeTypesRequest, ListNodeTypesResponse, ListSnapshotsRequest, ListSnapshotsResponse, ListUsersRequest, ListUsersResponse, ListVersionsRequest, ListVersionsResponse, RestoreSnapshotRequest, Snapshot, UpdateInstanceRequest, UpdateSnapshotRequest, UpdateUserRequest, UpgradeInstanceRequest, User } from './types.gen';
|
|
4
4
|
/**
|
|
5
|
-
* Managed Database for MongoDB
|
|
5
|
+
* Managed Database for MongoDB®.
|
|
6
6
|
*
|
|
7
|
-
* This API allows you to manage your Managed Databases for MongoDB
|
|
7
|
+
* This API allows you to manage your Managed Databases for MongoDB®.
|
|
8
8
|
*/
|
|
9
9
|
export declare class API extends ParentAPI {
|
|
10
10
|
/** Lists the available regions of the API. */
|
|
@@ -22,7 +22,7 @@ export declare class API extends ParentAPI {
|
|
|
22
22
|
};
|
|
23
23
|
protected pageOfListVersions: (request?: Readonly<ListVersionsRequest>) => Promise<ListVersionsResponse>;
|
|
24
24
|
/**
|
|
25
|
-
* List available MongoDB
|
|
25
|
+
* List available MongoDB® versions.
|
|
26
26
|
*
|
|
27
27
|
* @param request - The request {@link ListVersionsRequest}
|
|
28
28
|
* @returns A Promise of ListVersionsResponse
|
|
@@ -33,14 +33,13 @@ export declare class API extends ParentAPI {
|
|
|
33
33
|
};
|
|
34
34
|
protected pageOfListInstances: (request?: Readonly<ListInstancesRequest>) => Promise<ListInstancesResponse>;
|
|
35
35
|
/**
|
|
36
|
-
* List MongoDB
|
|
37
|
-
* the specified region
|
|
38
|
-
*
|
|
39
|
-
*
|
|
40
|
-
*
|
|
41
|
-
*
|
|
42
|
-
*
|
|
43
|
-
* the parameter.
|
|
36
|
+
* List MongoDB® Database Instances. List all MongoDB® Database Instances in
|
|
37
|
+
* the specified region. By default, the MongoDB® Database Instances returned
|
|
38
|
+
* in the list are ordered by creation date in ascending order, though this
|
|
39
|
+
* can be modified via the order_by field. You can define additional
|
|
40
|
+
* parameters for your query, such as `tags` and `name`. For the `name`
|
|
41
|
+
* parameter, the value you include will be checked against the whole name
|
|
42
|
+
* string to see if it includes the string you put in the parameter.
|
|
44
43
|
*
|
|
45
44
|
* @param request - The request {@link ListInstancesRequest}
|
|
46
45
|
* @returns A Promise of ListInstancesResponse
|
|
@@ -50,8 +49,8 @@ export declare class API extends ParentAPI {
|
|
|
50
49
|
[Symbol.asyncIterator]: () => AsyncGenerator<Instance[], void, void>;
|
|
51
50
|
};
|
|
52
51
|
/**
|
|
53
|
-
* Get a MongoDB
|
|
54
|
-
* MongoDB
|
|
52
|
+
* Get a MongoDB® Database Instance. Retrieve information about a given
|
|
53
|
+
* MongoDB® Database Instance, specified by the `region` and `instance_id`
|
|
55
54
|
* parameters. Its full details, including name, status, IP address and port,
|
|
56
55
|
* are returned in the response object.
|
|
57
56
|
*
|
|
@@ -68,7 +67,7 @@ export declare class API extends ParentAPI {
|
|
|
68
67
|
*/
|
|
69
68
|
waitForInstance: (request: Readonly<GetInstanceRequest>, options?: Readonly<WaitForOptions<Instance>>) => Promise<Instance>;
|
|
70
69
|
/**
|
|
71
|
-
* Create a MongoDB
|
|
70
|
+
* Create a MongoDB® Database Instance. Create a new MongoDB® Database
|
|
72
71
|
* Instance.
|
|
73
72
|
*
|
|
74
73
|
* @param request - The request {@link CreateInstanceRequest}
|
|
@@ -76,7 +75,7 @@ export declare class API extends ParentAPI {
|
|
|
76
75
|
*/
|
|
77
76
|
createInstance: (request: Readonly<CreateInstanceRequest>) => Promise<Instance>;
|
|
78
77
|
/**
|
|
79
|
-
* Update a MongoDB
|
|
78
|
+
* Update a MongoDB® Database Instance. Update the parameters of a MongoDB®
|
|
80
79
|
* Database Instance.
|
|
81
80
|
*
|
|
82
81
|
* @param request - The request {@link UpdateInstanceRequest}
|
|
@@ -84,9 +83,9 @@ export declare class API extends ParentAPI {
|
|
|
84
83
|
*/
|
|
85
84
|
updateInstance: (request: Readonly<UpdateInstanceRequest>) => Promise<Instance>;
|
|
86
85
|
/**
|
|
87
|
-
* Delete a MongoDB
|
|
86
|
+
* Delete a MongoDB® Database Instance. Delete a given MongoDB® Database
|
|
88
87
|
* Instance, specified by the `region` and `instance_id` parameters. Deleting
|
|
89
|
-
* a MongoDB
|
|
88
|
+
* a MongoDB® Database Instance is permanent, and cannot be undone. Note that
|
|
90
89
|
* upon deletion all your data will be lost.
|
|
91
90
|
*
|
|
92
91
|
* @param request - The request {@link DeleteInstanceRequest}
|
|
@@ -135,6 +134,14 @@ export declare class API extends ParentAPI {
|
|
|
135
134
|
* @returns A Promise of Snapshot
|
|
136
135
|
*/
|
|
137
136
|
waitForSnapshot: (request: Readonly<GetSnapshotRequest>, options?: Readonly<WaitForOptions<Snapshot>>) => Promise<Snapshot>;
|
|
137
|
+
/**
|
|
138
|
+
* Update a Database Instance snapshot. Update the parameters of a snapshot of
|
|
139
|
+
* a Database Instance. You can update the `name` and `expires_at`
|
|
140
|
+
* parameters.
|
|
141
|
+
*
|
|
142
|
+
* @param request - The request {@link UpdateSnapshotRequest}
|
|
143
|
+
* @returns A Promise of Snapshot
|
|
144
|
+
*/
|
|
138
145
|
updateSnapshot: (request: Readonly<UpdateSnapshotRequest>) => Promise<Snapshot>;
|
|
139
146
|
/**
|
|
140
147
|
* Restore a Database Instance snapshot. Restore a given snapshot of a
|