@scaleway/sdk 1.5.0 → 1.6.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.
Files changed (35) hide show
  1. package/dist/api/applesilicon/v1alpha1/api.gen.js +1 -1
  2. package/dist/api/baremetal/v1/api.gen.js +2 -2
  3. package/dist/api/cockpit/v1beta1/api.gen.js +51 -1
  4. package/dist/api/cockpit/v1beta1/marshalling.gen.js +44 -1
  5. package/dist/api/container/v1beta1/api.gen.js +1 -1
  6. package/dist/api/flexibleip/v1alpha1/api.gen.js +1 -1
  7. package/dist/api/function/v1beta1/api.gen.js +1 -1
  8. package/dist/api/function/v1beta1/marshalling.gen.js +0 -20
  9. package/dist/api/iam/v1alpha1/validation-rules.gen.js +10 -10
  10. package/dist/api/instance/v1/api.gen.js +86 -67
  11. package/dist/api/iot/v1/api.gen.js +1 -1
  12. package/dist/api/k8s/v1/api.gen.js +1 -1
  13. package/dist/api/lb/v1/api.gen.js +2 -2
  14. package/dist/api/lb/v1/marshalling.gen.js +33 -19
  15. package/dist/api/mnq/v1alpha1/api.gen.js +1 -1
  16. package/dist/api/rdb/v1/api.gen.js +1 -1
  17. package/dist/api/redis/v1/api.gen.js +1 -1
  18. package/dist/api/redis/v1/marshalling.gen.js +2 -0
  19. package/dist/api/registry/v1/api.gen.js +1 -1
  20. package/dist/api/secret/v1alpha1/api.gen.js +1 -1
  21. package/dist/api/secret/v1alpha1/marshalling.gen.js +14 -2
  22. package/dist/api/tem/v1alpha1/api.gen.js +1 -1
  23. package/dist/api/vpc/v1/api.gen.js +2 -2
  24. package/dist/api/vpcgw/v1/api.gen.js +1 -1
  25. package/dist/api/webhosting/v1alpha1/api.gen.js +1 -1
  26. package/dist/index.cjs +276 -121
  27. package/dist/index.d.ts +669 -504
  28. package/dist/internal/async/interval-retrier.js +6 -0
  29. package/dist/internal/logger/level-resolver.js +3 -3
  30. package/dist/scw/client-ini-factory.js +6 -0
  31. package/dist/scw/client-ini-profile.js +18 -0
  32. package/dist/scw/client-settings.js +12 -0
  33. package/dist/scw/constants.js +1 -1
  34. package/dist/scw/errors/standard/quotas-exceeded-error.js +6 -0
  35. package/package.json +2 -2
package/dist/index.d.ts CHANGED
@@ -2835,7 +2835,9 @@ declare namespace index$o {
2835
2835
  type CockpitStatus = 'unknown_status' | 'creating' | 'ready' | 'deleting' | 'updating' | 'error';
2836
2836
  type GrafanaUserRole = 'unknown_role' | 'editor' | 'viewer';
2837
2837
  type ListGrafanaUsersRequestOrderBy = 'login_asc' | 'login_desc';
2838
+ type ListPlansRequestOrderBy = 'name_asc' | 'name_desc';
2838
2839
  type ListTokensRequestOrderBy$2 = 'created_at_asc' | 'created_at_desc' | 'name_asc' | 'name_desc';
2840
+ type PlanName = 'unknown_name' | 'free' | 'premium' | 'custom';
2839
2841
  /** Cockpit. */
2840
2842
  interface Cockpit {
2841
2843
  /** Project ID. */
@@ -2850,6 +2852,8 @@ interface Cockpit {
2850
2852
  status: CockpitStatus;
2851
2853
  /** Managed alerts enabled. */
2852
2854
  managedAlertsEnabled: boolean;
2855
+ /** Pricing plan. */
2856
+ plan?: Plan;
2853
2857
  }
2854
2858
  /** Cockpit. endpoints. */
2855
2859
  interface CockpitEndpoints {
@@ -2858,6 +2862,11 @@ interface CockpitEndpoints {
2858
2862
  alertmanagerUrl: string;
2859
2863
  grafanaUrl: string;
2860
2864
  }
2865
+ /** Cockpit metrics. */
2866
+ interface CockpitMetrics {
2867
+ /** Timeseries array. */
2868
+ timeseries: TimeSeries[];
2869
+ }
2861
2870
  /** Alert contact point. Contact point. */
2862
2871
  interface ContactPoint {
2863
2872
  /**
@@ -2893,11 +2902,36 @@ interface ListGrafanaUsersResponse {
2893
2902
  totalCount: number;
2894
2903
  grafanaUsers: GrafanaUser[];
2895
2904
  }
2905
+ /** List all pricing plans response. List plans response. */
2906
+ interface ListPlansResponse {
2907
+ totalCount: number;
2908
+ plans: Plan[];
2909
+ }
2896
2910
  /** List tokens response. */
2897
2911
  interface ListTokensResponse$2 {
2898
2912
  totalCount: number;
2899
2913
  tokens: Token$2[];
2900
2914
  }
2915
+ /** Plan. */
2916
+ interface Plan {
2917
+ /** Plan id. */
2918
+ id: string;
2919
+ /** Plan name. */
2920
+ name: PlanName;
2921
+ /** Retention for metrics. */
2922
+ retentionMetricsInterval?: string;
2923
+ /** Retention for logs. */
2924
+ retentionLogsInterval?: string;
2925
+ /** Ingestion price for 1million samples in cents. */
2926
+ sampleIngestionPrice: number;
2927
+ /** Ingestion price in cents for 1 Go of logs. */
2928
+ logsIngestionPrice: number;
2929
+ /** Retention price in euros per month. */
2930
+ retentionPrice: number;
2931
+ }
2932
+ /** Select pricing plan response. Select plan response. */
2933
+ interface SelectPlanResponse {
2934
+ }
2901
2935
  /** Token. */
2902
2936
  interface Token$2 {
2903
2937
  id: string;
@@ -2924,6 +2958,16 @@ type ActivateCockpitRequest = {
2924
2958
  type GetCockpitRequest = {
2925
2959
  projectId?: string;
2926
2960
  };
2961
+ type GetCockpitMetricsRequest = {
2962
+ /** Project ID. */
2963
+ projectId?: string;
2964
+ /** Start date. */
2965
+ startDate?: Date;
2966
+ /** End date. */
2967
+ endDate?: Date;
2968
+ /** Metric name. */
2969
+ metricName?: string;
2970
+ };
2927
2971
  type DeactivateCockpitRequest = {
2928
2972
  projectId?: string;
2929
2973
  };
@@ -2994,6 +3038,15 @@ type ResetGrafanaUserPasswordRequest = {
2994
3038
  grafanaUserId: number;
2995
3039
  projectId?: string;
2996
3040
  };
3041
+ type ListPlansRequest = {
3042
+ page?: number;
3043
+ pageSize?: number;
3044
+ orderBy?: ListPlansRequestOrderBy;
3045
+ };
3046
+ type SelectPlanRequest = {
3047
+ projectId?: string;
3048
+ planId: string;
3049
+ };
2997
3050
 
2998
3051
  /**
2999
3052
  * Cockpit API.
@@ -3024,6 +3077,13 @@ declare class API$l extends API$q {
3024
3077
  * @returns A Promise of Cockpit
3025
3078
  */
3026
3079
  waitForCockpit: (request?: Readonly<GetCockpitRequest>, options?: Readonly<WaitForOptions<Cockpit>>) => Promise<Cockpit>;
3080
+ /**
3081
+ * Get cockpit metrics. Get the cockpit metrics with the given project ID.
3082
+ *
3083
+ * @param request - The request {@link GetCockpitMetricsRequest}
3084
+ * @returns A Promise of CockpitMetrics
3085
+ */
3086
+ getCockpitMetrics: (request?: Readonly<GetCockpitMetricsRequest>) => Promise<CockpitMetrics>;
3027
3087
  /**
3028
3088
  * Deactivate a cockpit. Deactivate a cockpit associated with the given
3029
3089
  * project ID.
@@ -3055,13 +3115,7 @@ declare class API$l extends API$q {
3055
3115
  * @returns A Promise of ListTokensResponse
3056
3116
  */
3057
3117
  listTokens: (request?: Readonly<ListTokensRequest$2>) => Promise<ListTokensResponse$2> & {
3058
- all: () => Promise<Token$2[]>; /**
3059
- * Waits for {@link Cockpit} to be in a final state.
3060
- *
3061
- * @param request - The request {@link GetCockpitRequest}
3062
- * @param options - The waiting options
3063
- * @returns A Promise of Cockpit
3064
- */
3118
+ all: () => Promise<Token$2[]>;
3065
3119
  [Symbol.asyncIterator]: () => AsyncGenerator<Token$2[], void, void>;
3066
3120
  };
3067
3121
  /**
@@ -3094,13 +3148,7 @@ declare class API$l extends API$q {
3094
3148
  * @returns A Promise of ListContactPointsResponse
3095
3149
  */
3096
3150
  listContactPoints: (request?: Readonly<ListContactPointsRequest>) => Promise<ListContactPointsResponse> & {
3097
- all: () => Promise<ContactPoint[]>; /**
3098
- * Waits for {@link Cockpit} to be in a final state.
3099
- *
3100
- * @param request - The request {@link GetCockpitRequest}
3101
- * @param options - The waiting options
3102
- * @returns A Promise of Cockpit
3103
- */
3151
+ all: () => Promise<ContactPoint[]>;
3104
3152
  [Symbol.asyncIterator]: () => AsyncGenerator<ContactPoint[], void, void>;
3105
3153
  };
3106
3154
  /**
@@ -3144,13 +3192,7 @@ declare class API$l extends API$q {
3144
3192
  * @returns A Promise of ListGrafanaUsersResponse
3145
3193
  */
3146
3194
  listGrafanaUsers: (request?: Readonly<ListGrafanaUsersRequest>) => Promise<ListGrafanaUsersResponse> & {
3147
- all: () => Promise<GrafanaUser[]>; /**
3148
- * Waits for {@link Cockpit} to be in a final state.
3149
- *
3150
- * @param request - The request {@link GetCockpitRequest}
3151
- * @param options - The waiting options
3152
- * @returns A Promise of Cockpit
3153
- */
3195
+ all: () => Promise<GrafanaUser[]>;
3154
3196
  [Symbol.asyncIterator]: () => AsyncGenerator<GrafanaUser[], void, void>;
3155
3197
  };
3156
3198
  /**
@@ -3167,6 +3209,24 @@ declare class API$l extends API$q {
3167
3209
  * @returns A Promise of GrafanaUser
3168
3210
  */
3169
3211
  resetGrafanaUserPassword: (request: Readonly<ResetGrafanaUserPasswordRequest>) => Promise<GrafanaUser>;
3212
+ protected pageOfListPlans: (request?: Readonly<ListPlansRequest>) => Promise<ListPlansResponse>;
3213
+ /**
3214
+ * List plans. List all pricing plans.
3215
+ *
3216
+ * @param request - The request {@link ListPlansRequest}
3217
+ * @returns A Promise of ListPlansResponse
3218
+ */
3219
+ listPlans: (request?: Readonly<ListPlansRequest>) => Promise<ListPlansResponse> & {
3220
+ all: () => Promise<Plan[]>;
3221
+ [Symbol.asyncIterator]: () => AsyncGenerator<Plan[], void, void>;
3222
+ };
3223
+ /**
3224
+ * Select pricing plan. Select the wanted pricing plan.
3225
+ *
3226
+ * @param request - The request {@link SelectPlanRequest}
3227
+ * @returns A Promise of SelectPlanResponse
3228
+ */
3229
+ selectPlan: (request: Readonly<SelectPlanRequest>) => Promise<SelectPlanResponse>;
3170
3230
  }
3171
3231
 
3172
3232
  /** Lists transient statutes of the enum {@link CockpitStatus}. */
@@ -3176,6 +3236,7 @@ type index_gen$i_ActivateCockpitRequest = ActivateCockpitRequest;
3176
3236
  declare const index_gen$i_COCKPIT_TRANSIENT_STATUSES: typeof COCKPIT_TRANSIENT_STATUSES;
3177
3237
  type index_gen$i_Cockpit = Cockpit;
3178
3238
  type index_gen$i_CockpitEndpoints = CockpitEndpoints;
3239
+ type index_gen$i_CockpitMetrics = CockpitMetrics;
3179
3240
  type index_gen$i_CockpitStatus = CockpitStatus;
3180
3241
  type index_gen$i_ContactPoint = ContactPoint;
3181
3242
  type index_gen$i_ContactPointEmail = ContactPointEmail;
@@ -3186,6 +3247,7 @@ type index_gen$i_DeleteContactPointRequest = DeleteContactPointRequest;
3186
3247
  type index_gen$i_DeleteGrafanaUserRequest = DeleteGrafanaUserRequest;
3187
3248
  type index_gen$i_DisableManagedAlertsRequest = DisableManagedAlertsRequest;
3188
3249
  type index_gen$i_EnableManagedAlertsRequest = EnableManagedAlertsRequest;
3250
+ type index_gen$i_GetCockpitMetricsRequest = GetCockpitMetricsRequest;
3189
3251
  type index_gen$i_GetCockpitRequest = GetCockpitRequest;
3190
3252
  type index_gen$i_GrafanaUser = GrafanaUser;
3191
3253
  type index_gen$i_GrafanaUserRole = GrafanaUserRole;
@@ -3194,8 +3256,15 @@ type index_gen$i_ListContactPointsResponse = ListContactPointsResponse;
3194
3256
  type index_gen$i_ListGrafanaUsersRequest = ListGrafanaUsersRequest;
3195
3257
  type index_gen$i_ListGrafanaUsersRequestOrderBy = ListGrafanaUsersRequestOrderBy;
3196
3258
  type index_gen$i_ListGrafanaUsersResponse = ListGrafanaUsersResponse;
3259
+ type index_gen$i_ListPlansRequest = ListPlansRequest;
3260
+ type index_gen$i_ListPlansRequestOrderBy = ListPlansRequestOrderBy;
3261
+ type index_gen$i_ListPlansResponse = ListPlansResponse;
3262
+ type index_gen$i_Plan = Plan;
3263
+ type index_gen$i_PlanName = PlanName;
3197
3264
  type index_gen$i_ResetCockpitGrafanaRequest = ResetCockpitGrafanaRequest;
3198
3265
  type index_gen$i_ResetGrafanaUserPasswordRequest = ResetGrafanaUserPasswordRequest;
3266
+ type index_gen$i_SelectPlanRequest = SelectPlanRequest;
3267
+ type index_gen$i_SelectPlanResponse = SelectPlanResponse;
3199
3268
  type index_gen$i_TokenScopes = TokenScopes;
3200
3269
  type index_gen$i_TriggerTestAlertRequest = TriggerTestAlertRequest;
3201
3270
  declare namespace index_gen$i {
@@ -3205,6 +3274,7 @@ declare namespace index_gen$i {
3205
3274
  index_gen$i_COCKPIT_TRANSIENT_STATUSES as COCKPIT_TRANSIENT_STATUSES,
3206
3275
  index_gen$i_Cockpit as Cockpit,
3207
3276
  index_gen$i_CockpitEndpoints as CockpitEndpoints,
3277
+ index_gen$i_CockpitMetrics as CockpitMetrics,
3208
3278
  index_gen$i_CockpitStatus as CockpitStatus,
3209
3279
  index_gen$i_ContactPoint as ContactPoint,
3210
3280
  index_gen$i_ContactPointEmail as ContactPointEmail,
@@ -3217,6 +3287,7 @@ declare namespace index_gen$i {
3217
3287
  DeleteTokenRequest$2 as DeleteTokenRequest,
3218
3288
  index_gen$i_DisableManagedAlertsRequest as DisableManagedAlertsRequest,
3219
3289
  index_gen$i_EnableManagedAlertsRequest as EnableManagedAlertsRequest,
3290
+ index_gen$i_GetCockpitMetricsRequest as GetCockpitMetricsRequest,
3220
3291
  index_gen$i_GetCockpitRequest as GetCockpitRequest,
3221
3292
  GetTokenRequest$2 as GetTokenRequest,
3222
3293
  index_gen$i_GrafanaUser as GrafanaUser,
@@ -3226,11 +3297,18 @@ declare namespace index_gen$i {
3226
3297
  index_gen$i_ListGrafanaUsersRequest as ListGrafanaUsersRequest,
3227
3298
  index_gen$i_ListGrafanaUsersRequestOrderBy as ListGrafanaUsersRequestOrderBy,
3228
3299
  index_gen$i_ListGrafanaUsersResponse as ListGrafanaUsersResponse,
3300
+ index_gen$i_ListPlansRequest as ListPlansRequest,
3301
+ index_gen$i_ListPlansRequestOrderBy as ListPlansRequestOrderBy,
3302
+ index_gen$i_ListPlansResponse as ListPlansResponse,
3229
3303
  ListTokensRequest$2 as ListTokensRequest,
3230
3304
  ListTokensRequestOrderBy$2 as ListTokensRequestOrderBy,
3231
3305
  ListTokensResponse$2 as ListTokensResponse,
3306
+ index_gen$i_Plan as Plan,
3307
+ index_gen$i_PlanName as PlanName,
3232
3308
  index_gen$i_ResetCockpitGrafanaRequest as ResetCockpitGrafanaRequest,
3233
3309
  index_gen$i_ResetGrafanaUserPasswordRequest as ResetGrafanaUserPasswordRequest,
3310
+ index_gen$i_SelectPlanRequest as SelectPlanRequest,
3311
+ index_gen$i_SelectPlanResponse as SelectPlanResponse,
3234
3312
  Token$2 as Token,
3235
3313
  index_gen$i_TokenScopes as TokenScopes,
3236
3314
  index_gen$i_TriggerTestAlertRequest as TriggerTestAlertRequest,
@@ -6537,21 +6615,7 @@ interface TriggerSqsClientConfig {
6537
6615
  accessKey: string;
6538
6616
  secretKey: string;
6539
6617
  }
6540
- interface UpdateTriggerRequestMnqNatsClientConfig {
6541
- mnqNamespaceId: string;
6542
- subject: string;
6543
- mnqProjectId: string;
6544
- mnqRegion: string;
6545
- }
6546
- interface UpdateTriggerRequestMnqSqsClientConfig {
6547
- mnqNamespaceId: string;
6548
- queue: string;
6549
- mnqProjectId: string;
6550
- mnqRegion: string;
6551
- }
6552
6618
  interface UpdateTriggerRequestSqsClientConfig {
6553
- endpoint: string;
6554
- queueUrl: string;
6555
6619
  accessKey: string;
6556
6620
  secretKey: string;
6557
6621
  }
@@ -6945,21 +7009,8 @@ type UpdateTriggerRequest = {
6945
7009
  triggerId: string;
6946
7010
  name?: string;
6947
7011
  description?: string;
6948
- /**
6949
- * One-of ('config'): at most one of 'scwSqsConfig', 'sqsConfig',
6950
- * 'scwNatsConfig' could be set.
6951
- */
6952
- scwSqsConfig?: UpdateTriggerRequestMnqSqsClientConfig;
6953
- /**
6954
- * One-of ('config'): at most one of 'scwSqsConfig', 'sqsConfig',
6955
- * 'scwNatsConfig' could be set.
6956
- */
7012
+ /** One-of ('config'): at most one of 'sqsConfig' could be set. */
6957
7013
  sqsConfig?: UpdateTriggerRequestSqsClientConfig;
6958
- /**
6959
- * One-of ('config'): at most one of 'scwSqsConfig', 'sqsConfig',
6960
- * 'scwNatsConfig' could be set.
6961
- */
6962
- scwNatsConfig?: UpdateTriggerRequestMnqNatsClientConfig;
6963
7014
  };
6964
7015
  type DeleteTriggerRequest = {
6965
7016
  /**
@@ -7346,8 +7397,6 @@ type index_gen$e_TriggerStatus = TriggerStatus;
7346
7397
  type index_gen$e_UpdateCronRequest = UpdateCronRequest;
7347
7398
  type index_gen$e_UpdateFunctionRequest = UpdateFunctionRequest;
7348
7399
  type index_gen$e_UpdateTriggerRequest = UpdateTriggerRequest;
7349
- type index_gen$e_UpdateTriggerRequestMnqNatsClientConfig = UpdateTriggerRequestMnqNatsClientConfig;
7350
- type index_gen$e_UpdateTriggerRequestMnqSqsClientConfig = UpdateTriggerRequestMnqSqsClientConfig;
7351
7400
  type index_gen$e_UpdateTriggerRequestSqsClientConfig = UpdateTriggerRequestSqsClientConfig;
7352
7401
  type index_gen$e_UploadURL = UploadURL;
7353
7402
  declare namespace index_gen$e {
@@ -7438,8 +7487,6 @@ declare namespace index_gen$e {
7438
7487
  index_gen$e_UpdateFunctionRequest as UpdateFunctionRequest,
7439
7488
  UpdateNamespaceRequest$2 as UpdateNamespaceRequest,
7440
7489
  index_gen$e_UpdateTriggerRequest as UpdateTriggerRequest,
7441
- index_gen$e_UpdateTriggerRequestMnqNatsClientConfig as UpdateTriggerRequestMnqNatsClientConfig,
7442
- index_gen$e_UpdateTriggerRequestMnqSqsClientConfig as UpdateTriggerRequestMnqSqsClientConfig,
7443
7490
  index_gen$e_UpdateTriggerRequestSqsClientConfig as UpdateTriggerRequestSqsClientConfig,
7444
7491
  index_gen$e_UploadURL as UploadURL,
7445
7492
  };
@@ -8702,7 +8749,7 @@ declare const ListAPIKeysRequest: {
8702
8749
  maxLength: number;
8703
8750
  };
8704
8751
  page: {
8705
- greaterThanOrEqual: number;
8752
+ greaterThan: number;
8706
8753
  };
8707
8754
  pageSize: {
8708
8755
  greaterThanOrEqual: number;
@@ -8716,7 +8763,7 @@ declare const ListApplicationsRequest: {
8716
8763
  pattern: RegExp;
8717
8764
  };
8718
8765
  page: {
8719
- greaterThanOrEqual: number;
8766
+ greaterThan: number;
8720
8767
  };
8721
8768
  pageSize: {
8722
8769
  greaterThanOrEqual: number;
@@ -8728,7 +8775,7 @@ declare const ListGroupsRequest: {
8728
8775
  minLength: number;
8729
8776
  };
8730
8777
  page: {
8731
- greaterThanOrEqual: number;
8778
+ greaterThan: number;
8732
8779
  };
8733
8780
  pageSize: {
8734
8781
  greaterThanOrEqual: number;
@@ -8737,7 +8784,7 @@ declare const ListGroupsRequest: {
8737
8784
  };
8738
8785
  declare const ListJWTsRequest: {
8739
8786
  page: {
8740
- greaterThanOrEqual: number;
8787
+ greaterThan: number;
8741
8788
  };
8742
8789
  pageSize: {
8743
8790
  greaterThanOrEqual: number;
@@ -8746,7 +8793,7 @@ declare const ListJWTsRequest: {
8746
8793
  };
8747
8794
  declare const ListPermissionSetsRequest: {
8748
8795
  page: {
8749
- greaterThanOrEqual: number;
8796
+ greaterThan: number;
8750
8797
  };
8751
8798
  pageSize: {
8752
8799
  greaterThanOrEqual: number;
@@ -8755,7 +8802,7 @@ declare const ListPermissionSetsRequest: {
8755
8802
  };
8756
8803
  declare const ListPoliciesRequest: {
8757
8804
  page: {
8758
- greaterThanOrEqual: number;
8805
+ greaterThan: number;
8759
8806
  };
8760
8807
  pageSize: {
8761
8808
  greaterThanOrEqual: number;
@@ -8767,7 +8814,7 @@ declare const ListPoliciesRequest: {
8767
8814
  };
8768
8815
  declare const ListQuotaRequest: {
8769
8816
  page: {
8770
- greaterThanOrEqual: number;
8817
+ greaterThan: number;
8771
8818
  };
8772
8819
  pageSize: {
8773
8820
  greaterThanOrEqual: number;
@@ -8776,7 +8823,7 @@ declare const ListQuotaRequest: {
8776
8823
  };
8777
8824
  declare const ListRulesRequest: {
8778
8825
  page: {
8779
- greaterThanOrEqual: number;
8826
+ greaterThan: number;
8780
8827
  };
8781
8828
  pageSize: {
8782
8829
  greaterThanOrEqual: number;
@@ -8789,7 +8836,7 @@ declare const ListSSHKeysRequest: {
8789
8836
  minLength: number;
8790
8837
  };
8791
8838
  page: {
8792
- greaterThanOrEqual: number;
8839
+ greaterThan: number;
8793
8840
  };
8794
8841
  pageSize: {
8795
8842
  greaterThanOrEqual: number;
@@ -8798,7 +8845,7 @@ declare const ListSSHKeysRequest: {
8798
8845
  };
8799
8846
  declare const ListUsersRequest$1: {
8800
8847
  page: {
8801
- greaterThanOrEqual: number;
8848
+ greaterThan: number;
8802
8849
  };
8803
8850
  pageSize: {
8804
8851
  greaterThanOrEqual: number;
@@ -9054,35 +9101,35 @@ type VolumeState = 'available' | 'snapshotting' | 'error' | 'fetching' | 'resizi
9054
9101
  type VolumeVolumeType = 'l_ssd' | 'b_ssd' | 'unified';
9055
9102
  /** Bootscript. */
9056
9103
  interface Bootscript {
9057
- /** The bootscript arguments. */
9104
+ /** Bootscript arguments. */
9058
9105
  bootcmdargs: string;
9059
9106
  /**
9060
- * Dispmay if the bootscript is the default bootscript if no other boot option
9061
- * is configured.
9107
+ * Display if the bootscript is the default bootscript (if no other boot
9108
+ * option is configured).
9062
9109
  */
9063
9110
  default: boolean;
9064
9111
  /**
9065
- * Provide information regarding a Device Tree Binary (dtb) for use with C1
9112
+ * Provide information regarding a Device Tree Binary (DTB) for use with C1
9066
9113
  * servers.
9067
9114
  */
9068
9115
  dtb: string;
9069
- /** The bootscript ID. */
9116
+ /** Bootscript ID. */
9070
9117
  id: string;
9071
- /** The initrd (initial ramdisk) configuration. */
9118
+ /** Initrd (initial ramdisk) configuration. */
9072
9119
  initrd: string;
9073
- /** The server kernel version. */
9120
+ /** Instance kernel version. */
9074
9121
  kernel: string;
9075
- /** The bootscript organization ID. */
9122
+ /** Bootscript Organization ID. */
9076
9123
  organization: string;
9077
- /** The bootscript project ID. */
9124
+ /** Bootscript Project ID. */
9078
9125
  project: string;
9079
9126
  /** Provide information if the bootscript is public. */
9080
9127
  public: boolean;
9081
- /** The bootscript title. */
9128
+ /** Bootscript title. */
9082
9129
  title: string;
9083
- /** The bootscript arch. */
9130
+ /** Bootscript architecture. */
9084
9131
  arch: Arch;
9085
- /** The zone in which is the bootscript. */
9132
+ /** Zone in which the bootscript is located. */
9086
9133
  zone: Zone;
9087
9134
  }
9088
9135
  interface CreateImageResponse {
@@ -9148,7 +9195,9 @@ interface GetIpResponse {
9148
9195
  interface GetPlacementGroupResponse {
9149
9196
  placementGroup?: PlacementGroup;
9150
9197
  }
9198
+ /** Get placement group servers response. */
9151
9199
  interface GetPlacementGroupServersResponse {
9200
+ /** Instances attached to the placement group. */
9152
9201
  servers: PlacementGroupServer[];
9153
9202
  }
9154
9203
  interface GetPrivateNICResponse {
@@ -9257,16 +9306,16 @@ interface ListServerUserDataResponse {
9257
9306
  }
9258
9307
  /** List servers response. */
9259
9308
  interface ListServersResponse {
9260
- /** Total number of servers. */
9309
+ /** Total number of Instances. */
9261
9310
  totalCount: number;
9262
- /** List of servers. */
9311
+ /** List of Instances. */
9263
9312
  servers: Server[];
9264
9313
  }
9265
9314
  /** List servers types response. */
9266
9315
  interface ListServersTypesResponse {
9267
- /** Total number of server types. */
9316
+ /** Total number of Instance types. */
9268
9317
  totalCount: number;
9269
- /** List of server types. */
9318
+ /** List of Instance types. */
9270
9319
  servers: Record<string, ServerType>;
9271
9320
  }
9272
9321
  /** List snapshots response. */
@@ -9292,18 +9341,18 @@ interface ListVolumesTypesResponse {
9292
9341
  }
9293
9342
  /** Placement group. */
9294
9343
  interface PlacementGroup {
9295
- /** The placement group unique ID. */
9344
+ /** Placement group unique ID. */
9296
9345
  id: string;
9297
- /** The placement group name. */
9346
+ /** Placement group name. */
9298
9347
  name: string;
9299
- /** The placement group organization ID. */
9348
+ /** Placement group Organization ID. */
9300
9349
  organization: string;
9301
- /** The placement group project ID. */
9350
+ /** Placement group Project ID. */
9302
9351
  project: string;
9303
- /** The placement group tags. */
9352
+ /** Placement group tags. */
9304
9353
  tags: string[];
9305
9354
  /**
9306
- * Select the failling mode when the placement cannot be respected, either
9355
+ * Select the failure mode when the placement cannot be respected, either
9307
9356
  * optional or enforced.
9308
9357
  */
9309
9358
  policyMode: PlacementGroupPolicyMode;
@@ -9314,67 +9363,71 @@ interface PlacementGroup {
9314
9363
  policyType: PlacementGroupPolicyType;
9315
9364
  /** Returns true if the policy is respected, false otherwise. */
9316
9365
  policyRespected: boolean;
9317
- /** The zone in which is the placement group. */
9366
+ /** Zone in which the placement group is located. */
9318
9367
  zone: Zone;
9319
9368
  }
9369
+ /** Placement group server. */
9320
9370
  interface PlacementGroupServer {
9371
+ /** Instance UUID. */
9321
9372
  id: string;
9373
+ /** Instance name. */
9322
9374
  name: string;
9375
+ /** Defines whether the placement group policy is respected (either 1 or 0). */
9323
9376
  policyRespected: boolean;
9324
9377
  }
9325
9378
  /** Private nic. */
9326
9379
  interface PrivateNIC {
9327
- /** The private NIC unique ID. */
9380
+ /** Private NIC unique ID. */
9328
9381
  id: string;
9329
- /** The server the private NIC is attached to. */
9382
+ /** Instance to which the private NIC is attached. */
9330
9383
  serverId: string;
9331
- /** The private network where the private NIC is attached. */
9384
+ /** Private Network the private NIC is attached to. */
9332
9385
  privateNetworkId: string;
9333
- /** The private NIC MAC address. */
9386
+ /** Private NIC MAC address. */
9334
9387
  macAddress: string;
9335
- /** The private NIC state. */
9388
+ /** Private NIC state. */
9336
9389
  state: PrivateNICState;
9337
- /** The private NIC tags. */
9390
+ /** Private NIC tags. */
9338
9391
  tags: string[];
9339
9392
  }
9340
9393
  /** Security group. */
9341
9394
  interface SecurityGroup {
9342
- /** The security groups' unique ID. */
9395
+ /** Security group unique ID. */
9343
9396
  id: string;
9344
- /** The security groups name. */
9397
+ /** Security group name. */
9345
9398
  name: string;
9346
- /** The security groups description. */
9399
+ /** Security group description. */
9347
9400
  description: string;
9348
9401
  /** True if SMTP is blocked on IPv4 and IPv6. */
9349
9402
  enableDefaultSecurity: boolean;
9350
- /** The default inbound policy. */
9403
+ /** Default inbound policy. */
9351
9404
  inboundDefaultPolicy: SecurityGroupPolicy;
9352
- /** The default outbound policy. */
9405
+ /** Default outbound policy. */
9353
9406
  outboundDefaultPolicy: SecurityGroupPolicy;
9354
- /** The security groups organization ID. */
9407
+ /** Security group Organization ID. */
9355
9408
  organization: string;
9356
- /** The security group project ID. */
9409
+ /** Security group Project ID. */
9357
9410
  project: string;
9358
- /** The security group tags. */
9411
+ /** Security group tags. */
9359
9412
  tags: string[];
9360
9413
  /**
9361
- * @deprecated True if it is your default security group for this organization
9414
+ * @deprecated True if it is your default security group for this Organization
9362
9415
  * ID.
9363
9416
  */
9364
9417
  organizationDefault?: boolean;
9365
- /** True if it is your default security group for this project ID. */
9418
+ /** True if it is your default security group for this Project ID. */
9366
9419
  projectDefault: boolean;
9367
- /** The security group creation date. */
9420
+ /** Security group creation date. */
9368
9421
  creationDate?: Date;
9369
- /** The security group modification date. */
9422
+ /** Security group modification date. */
9370
9423
  modificationDate?: Date;
9371
- /** List of servers attached to this security group. */
9424
+ /** List of Instances attached to this security group. */
9372
9425
  servers: ServerSummary[];
9373
- /** True if the security group is stateful. */
9426
+ /** Defines whether the security group is stateful. */
9374
9427
  stateful: boolean;
9375
9428
  /** Security group state. */
9376
9429
  state: SecurityGroupState;
9377
- /** The zone in which is the security group. */
9430
+ /** Zone in which the security group is located. */
9378
9431
  zone: Zone;
9379
9432
  }
9380
9433
  interface SecurityGroupRule {
@@ -9399,69 +9452,69 @@ interface SecurityGroupTemplate {
9399
9452
  }
9400
9453
  /** Server. */
9401
9454
  interface Server {
9402
- /** The server unique ID. */
9455
+ /** Instance unique ID. */
9403
9456
  id: string;
9404
- /** The server name. */
9457
+ /** Instance name. */
9405
9458
  name: string;
9406
- /** The server organization ID. */
9459
+ /** Instance Organization ID. */
9407
9460
  organization: string;
9408
- /** The server project ID. */
9461
+ /** Instance Project ID. */
9409
9462
  project: string;
9410
- /** Provide as list of allowed actions on the server. */
9463
+ /** List of allowed actions on the Instance. */
9411
9464
  allowedActions: ServerAction[];
9412
- /** The server associated tags. */
9465
+ /** Tags associated with the Instance. */
9413
9466
  tags: string[];
9414
- /** The server commercial type (eg. GP1-M). */
9467
+ /** Instance commercial type (eg. GP1-M). */
9415
9468
  commercialType: string;
9416
- /** The server creation date. */
9469
+ /** Instance creation date. */
9417
9470
  creationDate?: Date;
9418
9471
  /** True if a dynamic IP is required. */
9419
9472
  dynamicIpRequired: boolean;
9420
9473
  /** True if IPv6 is enabled. */
9421
9474
  enableIpv6: boolean;
9422
- /** The server host name. */
9475
+ /** Instance host name. */
9423
9476
  hostname: string;
9424
- /** Provide information on the server image. */
9477
+ /** Information about the Instance image. */
9425
9478
  image?: Image$3;
9426
- /** The server protection option is activated. */
9479
+ /** Defines whether the Instance protection option is activated. */
9427
9480
  protected: boolean;
9428
- /** The server private IP address. */
9481
+ /** Private IP address of the Instance. */
9429
9482
  privateIp?: string;
9430
9483
  /** Information about the public IP. */
9431
9484
  publicIp?: ServerIp;
9432
- /** The server modification date. */
9485
+ /** Instance modification date. */
9433
9486
  modificationDate?: Date;
9434
- /** The server state. */
9487
+ /** Instance state. */
9435
9488
  state: ServerState;
9436
- /** The server location. */
9489
+ /** Instance location. */
9437
9490
  location?: ServerLocation;
9438
- /** The server IPv6 address. */
9491
+ /** Instance IPv6 address. */
9439
9492
  ipv6?: ServerIpv6;
9440
- /** @deprecated The server bootscript. */
9493
+ /** @deprecated Instance bootscript. */
9441
9494
  bootscript?: Bootscript;
9442
- /** The server boot type. */
9495
+ /** Instance boot type. */
9443
9496
  bootType: BootType;
9444
- /** The server volumes. */
9497
+ /** Instance volumes. */
9445
9498
  volumes: Record<string, VolumeServer>;
9446
- /** The server security group. */
9499
+ /** Instance security group. */
9447
9500
  securityGroup?: SecurityGroupSummary;
9448
- /** The server planned maintenances. */
9501
+ /** Instance planned maintenance. */
9449
9502
  maintenances: ServerMaintenance[];
9450
- /** The server state_detail. */
9503
+ /** Detailed information about the Instance state. */
9451
9504
  stateDetail: string;
9452
- /** The server arch. */
9505
+ /** Instance architecture. */
9453
9506
  arch: Arch;
9454
- /** The server placement group. */
9507
+ /** Instance placement group. */
9455
9508
  placementGroup?: PlacementGroup;
9456
- /** The server private NICs. */
9509
+ /** Instance private NICs. */
9457
9510
  privateNics: PrivateNIC[];
9458
- /** The zone in which is the server. */
9511
+ /** Zone in which the Instance is located. */
9459
9512
  zone: Zone;
9460
9513
  }
9461
9514
  /** Server action request. volume backup template. */
9462
9515
  interface ServerActionRequestVolumeBackupTemplate {
9463
9516
  /**
9464
- * The snapshot's volume type. Overrides the volume_type of the snapshot for
9517
+ * Snapshot's volume type. Overrides the `volume_type` of the snapshot for
9465
9518
  * this volume. If omitted, the volume type of the original volume will be
9466
9519
  * used.
9467
9520
  */
@@ -9472,20 +9525,20 @@ interface ServerActionResponse {
9472
9525
  }
9473
9526
  /** Server. ip. */
9474
9527
  interface ServerIp {
9475
- /** The unique ID of the IP address. */
9528
+ /** Unique ID of the IP address. */
9476
9529
  id: string;
9477
- /** The server public IPv4 IP-Address. */
9530
+ /** Instance public IPv4 IP-Address. */
9478
9531
  address: string;
9479
9532
  /** True if the IP address is dynamic. */
9480
9533
  dynamic: boolean;
9481
9534
  }
9482
9535
  /** Server. ipv6. */
9483
9536
  interface ServerIpv6 {
9484
- /** The server IPv6 IP-Address. */
9537
+ /** Instance IPv6 IP-Address. */
9485
9538
  address: string;
9486
- /** The IPv6 IP-addresses gateway. */
9539
+ /** IPv6 IP-addresses gateway. */
9487
9540
  gateway: string;
9488
- /** The IPv6 IP-addresses CIDR netmask. */
9541
+ /** IPv6 IP-addresses CIDR netmask. */
9489
9542
  netmask: string;
9490
9543
  }
9491
9544
  interface ServerLocation {
@@ -9508,7 +9561,7 @@ interface ServerType {
9508
9561
  monthlyPrice?: number;
9509
9562
  /** Hourly price in Euro. */
9510
9563
  hourlyPrice: number;
9511
- /** Alternative instance name if any. */
9564
+ /** Alternative Instance name, if any. */
9512
9565
  altNames: string[];
9513
9566
  /** Additional volume constraints. */
9514
9567
  perVolumeConstraint?: ServerTypeVolumeConstraintsByType;
@@ -9522,16 +9575,16 @@ interface ServerType {
9522
9575
  ram: number;
9523
9576
  /** CPU architecture. */
9524
9577
  arch: Arch;
9525
- /** True if it is a baremetal instance. */
9578
+ /** True if it is a baremetal Instance. */
9526
9579
  baremetal: boolean;
9527
- /** Network available for the instance. */
9580
+ /** Network available for the Instance. */
9528
9581
  network?: ServerTypeNetwork;
9529
9582
  /** Capabilities. */
9530
9583
  capabilities?: ServerTypeCapabilities;
9531
9584
  }
9532
9585
  /** Server type. capabilities. */
9533
9586
  interface ServerTypeCapabilities {
9534
- /** True if server supports block storage. */
9587
+ /** Defines whether the Instance supports block storage. */
9535
9588
  blockStorage?: boolean;
9536
9589
  /** List of supported boot types. */
9537
9590
  bootTypes: BootType[];
@@ -9569,7 +9622,9 @@ interface ServerTypeVolumeConstraintsByType {
9569
9622
  interface SetPlacementGroupResponse {
9570
9623
  placementGroup?: PlacementGroup;
9571
9624
  }
9625
+ /** Set placement group servers response. */
9572
9626
  interface SetPlacementGroupServersResponse {
9627
+ /** Instances attached to the placement group. */
9573
9628
  servers: PlacementGroupServer[];
9574
9629
  }
9575
9630
  /** Set security group rules request. rule. */
@@ -9585,7 +9640,7 @@ interface SetSecurityGroupRulesRequestRule {
9585
9640
  protocol: SecurityGroupRuleProtocol;
9586
9641
  /** Direction the rule applies to. */
9587
9642
  direction: SecurityGroupRuleDirection;
9588
- /** The range of IP address this rules applies to. */
9643
+ /** Range of IP addresses these rules apply to. */
9589
9644
  ipRange: string;
9590
9645
  /**
9591
9646
  * Beginning of the range of ports this rule applies to (inclusive). This
@@ -9616,57 +9671,57 @@ interface SetSecurityGroupRulesResponse {
9616
9671
  }
9617
9672
  /** Snapshot. */
9618
9673
  interface Snapshot$1 {
9619
- /** The snapshot ID. */
9674
+ /** Snapshot ID. */
9620
9675
  id: string;
9621
- /** The snapshot name. */
9676
+ /** Snapshot name. */
9622
9677
  name: string;
9623
- /** The snapshot organization ID. */
9678
+ /** Snapshot Organization ID. */
9624
9679
  organization: string;
9625
- /** The snapshot project ID. */
9680
+ /** Snapshot Project ID. */
9626
9681
  project: string;
9627
- /** The snapshot tags. */
9682
+ /** Snapshot tags. */
9628
9683
  tags: string[];
9629
- /** The snapshot volume type. */
9684
+ /** Snapshot volume type. */
9630
9685
  volumeType: VolumeVolumeType;
9631
- /** The snapshot size. */
9686
+ /** Snapshot size. */
9632
9687
  size: number;
9633
- /** The snapshot state. */
9688
+ /** Snapshot state. */
9634
9689
  state: SnapshotState;
9635
- /** The volume on which the snapshot is based on. */
9690
+ /** Volume on which the snapshot is based on. */
9636
9691
  baseVolume?: SnapshotBaseVolume;
9637
- /** The snapshot creation date. */
9692
+ /** Snapshot creation date. */
9638
9693
  creationDate?: Date;
9639
- /** The snapshot modification date. */
9694
+ /** Snapshot modification date. */
9640
9695
  modificationDate?: Date;
9641
- /** The snapshot zone. */
9696
+ /** Snapshot zone. */
9642
9697
  zone: Zone;
9643
- /** The reason for the failed snapshot import. */
9698
+ /** Reason for the failed snapshot import. */
9644
9699
  errorReason?: string;
9645
9700
  }
9646
9701
  /** Snapshot. base volume. */
9647
9702
  interface SnapshotBaseVolume {
9648
- /** The volume ID on which the snapshot is based on. */
9703
+ /** Volume ID on which the snapshot is based. */
9649
9704
  id: string;
9650
- /** The volume name on which the snapshot is based on. */
9705
+ /** Volume name on which the snapshot is based on. */
9651
9706
  name: string;
9652
9707
  }
9653
9708
  /** Task. */
9654
9709
  interface Task {
9655
- /** The unique ID of the task. */
9710
+ /** Unique ID of the task. */
9656
9711
  id: string;
9657
- /** The description of the task. */
9712
+ /** Description of the task. */
9658
9713
  description: string;
9659
- /** The progress of the task in percent. */
9714
+ /** Progress of the task in percent. */
9660
9715
  progress: number;
9661
- /** The task start date. */
9716
+ /** Task start date. */
9662
9717
  startedAt?: Date;
9663
- /** The task end date. */
9718
+ /** Task end date. */
9664
9719
  terminatedAt?: Date;
9665
- /** The task status. */
9720
+ /** Task status. */
9666
9721
  status: TaskStatus;
9667
9722
  hrefFrom: string;
9668
9723
  hrefResult: string;
9669
- /** The zone in which is the task. */
9724
+ /** Zone in which the task is excecuted. */
9670
9725
  zone: Zone;
9671
9726
  }
9672
9727
  interface UpdateIpResponse {
@@ -9675,7 +9730,9 @@ interface UpdateIpResponse {
9675
9730
  interface UpdatePlacementGroupResponse {
9676
9731
  placementGroup?: PlacementGroup;
9677
9732
  }
9733
+ /** Update placement group servers response. */
9678
9734
  interface UpdatePlacementGroupServersResponse {
9735
+ /** Instances attached to the placement group. */
9679
9736
  servers: PlacementGroupServer[];
9680
9737
  }
9681
9738
  interface UpdateServerResponse {
@@ -9686,31 +9743,31 @@ interface UpdateVolumeResponse {
9686
9743
  }
9687
9744
  /** Volume. */
9688
9745
  interface Volume$1 {
9689
- /** The volume unique ID. */
9746
+ /** Volume unique ID. */
9690
9747
  id: string;
9691
- /** The volume name. */
9748
+ /** Volume name. */
9692
9749
  name: string;
9693
9750
  /** @deprecated Show the volume NBD export URI. */
9694
9751
  exportUri?: string;
9695
- /** The volume disk size. */
9752
+ /** Volume disk size. */
9696
9753
  size: number;
9697
- /** The volume type. */
9754
+ /** Volume type. */
9698
9755
  volumeType: VolumeVolumeType;
9699
- /** The volume creation date. */
9756
+ /** Volume creation date. */
9700
9757
  creationDate?: Date;
9701
- /** The volume modification date. */
9758
+ /** Volume modification date. */
9702
9759
  modificationDate?: Date;
9703
- /** The volume organization ID. */
9760
+ /** Volume Organization ID. */
9704
9761
  organization: string;
9705
- /** The volume project ID. */
9762
+ /** Volume Project ID. */
9706
9763
  project: string;
9707
- /** The volume tags. */
9764
+ /** Volume tags. */
9708
9765
  tags: string[];
9709
- /** The server attached to the volume. */
9766
+ /** Instance attached to the volume. */
9710
9767
  server?: ServerSummary;
9711
- /** The volume state. */
9768
+ /** Volume state. */
9712
9769
  state: VolumeState;
9713
- /** The zone in which is the volume. */
9770
+ /** Zone in which the volume is located. */
9714
9771
  zone: Zone;
9715
9772
  }
9716
9773
  interface VolumeServer {
@@ -9732,7 +9789,7 @@ interface VolumeServer {
9732
9789
  interface VolumeServerTemplate {
9733
9790
  /** UUID of the volume. */
9734
9791
  id: string;
9735
- /** Force the server to boot on this volume. */
9792
+ /** Force the Instance to boot on this volume. */
9736
9793
  boot: boolean;
9737
9794
  /** Name of the volume. */
9738
9795
  name: string;
@@ -9740,7 +9797,7 @@ interface VolumeServerTemplate {
9740
9797
  size: number;
9741
9798
  /** Type of the volume. */
9742
9799
  volumeType: VolumeVolumeType;
9743
- /** The ID of the snapshot on which this volume will be based. */
9800
+ /** ID of the snapshot on which this volume will be based. */
9744
9801
  baseSnapshot: string;
9745
9802
  /** Organization ID of the volume. */
9746
9803
  organization: string;
@@ -9818,29 +9875,29 @@ type ListServersRequest = {
9818
9875
  perPage?: number;
9819
9876
  /** A positive integer to choose the page to return. */
9820
9877
  page?: number;
9821
- /** List only servers of this organization ID. */
9878
+ /** List only Instances of this Organization ID. */
9822
9879
  organization?: string;
9823
- /** List only servers of this project ID. */
9880
+ /** List only Instances of this Project ID. */
9824
9881
  project?: string;
9825
9882
  /**
9826
- * Filter servers by name (for eg. "server1" will return "server100" and
9883
+ * Filter Instances by name (eg. "server1" will return "server100" and
9827
9884
  * "server1" but not "foo").
9828
9885
  */
9829
9886
  name?: string;
9830
- /** List servers by private_ip. */
9887
+ /** List Instances by private_ip. */
9831
9888
  privateIp?: string;
9832
- /** List servers that are not attached to a public IP. */
9889
+ /** List Instances that are not attached to a public IP. */
9833
9890
  withoutIp?: boolean;
9834
- /** List servers of this commercial type. */
9891
+ /** List Instances of this commercial type. */
9835
9892
  commercialType?: string;
9836
- /** List servers in this state. */
9893
+ /** List Instances in this state. */
9837
9894
  state?: ServerState;
9838
9895
  /**
9839
- * List servers with these exact tags (to filter with several tags, use commas
9840
- * to separate them).
9896
+ * List Instances with these exact tags (to filter with several tags, use
9897
+ * commas to separate them).
9841
9898
  */
9842
9899
  tags?: string[];
9843
- /** List servers in this Private Network. */
9900
+ /** List Instances in this Private Network. */
9844
9901
  privateNetwork?: string;
9845
9902
  /** Define the order of the returned servers. */
9846
9903
  order?: ListServersRequestOrder;
@@ -9853,7 +9910,7 @@ type DeleteServerRequest = {
9853
9910
  type GetServerRequest = {
9854
9911
  /** Zone to target. If none is passed will use default zone from the config. */
9855
9912
  zone?: Zone;
9856
- /** UUID of the server you want to get. */
9913
+ /** UUID of the Instance you want to get. */
9857
9914
  serverId: string;
9858
9915
  };
9859
9916
  type ListServerActionsRequest = {
@@ -9864,13 +9921,13 @@ type ListServerActionsRequest = {
9864
9921
  type ServerActionRequest = {
9865
9922
  /** Zone to target. If none is passed will use default zone from the config. */
9866
9923
  zone?: Zone;
9867
- /** UUID of the server. */
9924
+ /** UUID of the Instance. */
9868
9925
  serverId: string;
9869
- /** The action to perform on the server. */
9926
+ /** Action to perform on the Instance. */
9870
9927
  action?: ServerAction;
9871
9928
  /**
9872
- * The name of the backup you want to create. The name of the backup you want
9873
- * to create. This field should only be specified when performing a backup
9929
+ * Name of the backup you want to create. Name of the backup you want to
9930
+ * create. This field should only be specified when performing a backup
9874
9931
  * action.
9875
9932
  */
9876
9933
  name?: string;
@@ -9884,13 +9941,13 @@ type ServerActionRequest = {
9884
9941
  type ListServerUserDataRequest = {
9885
9942
  /** Zone to target. If none is passed will use default zone from the config. */
9886
9943
  zone?: Zone;
9887
- /** UUID of the server. */
9944
+ /** UUID of the Instance. */
9888
9945
  serverId: string;
9889
9946
  };
9890
9947
  type DeleteServerUserDataRequest = {
9891
9948
  /** Zone to target. If none is passed will use default zone from the config. */
9892
9949
  zone?: Zone;
9893
- /** UUID of the server. */
9950
+ /** UUID of the Instance. */
9894
9951
  serverId: string;
9895
9952
  /** Key of the user data to delete. */
9896
9953
  key: string;
@@ -9940,7 +9997,7 @@ type CreateImageRequest = {
9940
9997
  * could be set.
9941
9998
  */
9942
9999
  project?: string;
9943
- /** The tags of the image. */
10000
+ /** Tags of the image. */
9944
10001
  tags?: string[];
9945
10002
  /** True to create a public image. */
9946
10003
  public?: boolean;
@@ -9968,7 +10025,7 @@ type CreateSnapshotRequest$1 = {
9968
10025
  name?: string;
9969
10026
  /** UUID of the volume. */
9970
10027
  volumeId?: string;
9971
- /** The tags of the snapshot. */
10028
+ /** Tags of the snapshot. */
9972
10029
  tags?: string[];
9973
10030
  /**
9974
10031
  * @deprecated Organization ID of the snapshot.
@@ -9985,8 +10042,8 @@ type CreateSnapshotRequest$1 = {
9985
10042
  */
9986
10043
  project?: string;
9987
10044
  /**
9988
- * The volume type of the snapshot. Overrides the volume_type of the snapshot.
9989
- * If omitted, the volume type of the original volume will be used.
10045
+ * Volume type of the snapshot. Overrides the volume_type of the snapshot. If
10046
+ * omitted, the volume type of the original volume will be used.
9990
10047
  */
9991
10048
  volumeType?: SnapshotVolumeType;
9992
10049
  /** Bucket name for snapshot imports. */
@@ -10011,7 +10068,7 @@ type DeleteSnapshotRequest$1 = {
10011
10068
  type ExportSnapshotRequest = {
10012
10069
  /** Zone to target. If none is passed will use default zone from the config. */
10013
10070
  zone?: Zone;
10014
- /** The snapshot ID. */
10071
+ /** Snapshot ID. */
10015
10072
  snapshotId: string;
10016
10073
  /** S3 bucket name. */
10017
10074
  bucket: string;
@@ -10030,9 +10087,9 @@ type ListVolumesRequest = {
10030
10087
  perPage?: number;
10031
10088
  /** A positive integer to choose the page to return. */
10032
10089
  page?: number;
10033
- /** Filter volume by organization ID. */
10090
+ /** Filter volume by Organization ID. */
10034
10091
  organization?: string;
10035
- /** Filter volume by project ID. */
10092
+ /** Filter volume by Project ID. */
10036
10093
  project?: string;
10037
10094
  /**
10038
10095
  * Filter volumes with these exact tags (to filter with several tags, use
@@ -10048,42 +10105,42 @@ type ListVolumesRequest = {
10048
10105
  type CreateVolumeRequest = {
10049
10106
  /** Zone to target. If none is passed will use default zone from the config. */
10050
10107
  zone?: Zone;
10051
- /** The volume name. */
10108
+ /** Volume name. */
10052
10109
  name?: string;
10053
10110
  /**
10054
- * @deprecated The volume organization ID.
10111
+ * @deprecated Volume Organization ID.
10055
10112
  *
10056
10113
  * One-of ('projectIdentifier'): at most one of 'organization', 'project'
10057
10114
  * could be set.
10058
10115
  */
10059
10116
  organization?: string;
10060
10117
  /**
10061
- * The volume project ID.
10118
+ * Volume Project ID.
10062
10119
  *
10063
10120
  * One-of ('projectIdentifier'): at most one of 'organization', 'project'
10064
10121
  * could be set.
10065
10122
  */
10066
10123
  project?: string;
10067
- /** The volume tags. */
10124
+ /** Volume tags. */
10068
10125
  tags?: string[];
10069
- /** The volume type. */
10126
+ /** Volume type. */
10070
10127
  volumeType?: VolumeVolumeType;
10071
10128
  /**
10072
- * The volume disk size, must be a multiple of 512.
10129
+ * Volume disk size, must be a multiple of 512.
10073
10130
  *
10074
10131
  * One-of ('from'): at most one of 'size', 'baseVolume', 'baseSnapshot' could
10075
10132
  * be set.
10076
10133
  */
10077
10134
  size?: number;
10078
10135
  /**
10079
- * The ID of the volume on which this volume will be based.
10136
+ * ID of the volume on which this volume will be based.
10080
10137
  *
10081
10138
  * One-of ('from'): at most one of 'size', 'baseVolume', 'baseSnapshot' could
10082
10139
  * be set.
10083
10140
  */
10084
10141
  baseVolume?: string;
10085
10142
  /**
10086
- * The ID of the snapshot on which this volume will be based.
10143
+ * ID of the snapshot on which this volume will be based.
10087
10144
  *
10088
10145
  * One-of ('from'): at most one of 'size', 'baseVolume', 'baseSnapshot' could
10089
10146
  * be set.
@@ -10101,11 +10158,11 @@ type UpdateVolumeRequest = {
10101
10158
  zone?: Zone;
10102
10159
  /** UUID of the volume. */
10103
10160
  volumeId: string;
10104
- /** The volume name. */
10161
+ /** Volume name. */
10105
10162
  name?: string;
10106
- /** The tags of the volume. */
10163
+ /** Tags of the volume. */
10107
10164
  tags?: string[];
10108
- /** The volume disk size, must be a multiple of 512. */
10165
+ /** Volume disk size, must be a multiple of 512. */
10109
10166
  size?: number;
10110
10167
  };
10111
10168
  type DeleteVolumeRequest = {
@@ -10119,9 +10176,9 @@ type ListSecurityGroupsRequest = {
10119
10176
  zone?: Zone;
10120
10177
  /** Name of the security group. */
10121
10178
  name?: string;
10122
- /** The security group organization ID. */
10179
+ /** Security group Organization ID. */
10123
10180
  organization?: string;
10124
- /** The security group project ID. */
10181
+ /** Security group Project ID. */
10125
10182
  project?: string;
10126
10183
  /**
10127
10184
  * List security groups with these exact tags (to filter with several tags,
@@ -10159,11 +10216,11 @@ type CreateSecurityGroupRequest = {
10159
10216
  * could be set.
10160
10217
  */
10161
10218
  project?: string;
10162
- /** The tags of the security group. */
10219
+ /** Tags of the security group. */
10163
10220
  tags?: string[];
10164
10221
  /**
10165
- * @deprecated Whether this security group becomes the default security group
10166
- * for new instances.
10222
+ * @deprecated Defines whether this security group becomes the default
10223
+ * security group for new Instances.
10167
10224
  *
10168
10225
  * One-of ('defaultIdentifier'): at most one of 'organizationDefault',
10169
10226
  * 'projectDefault' could be set.
@@ -10171,7 +10228,7 @@ type CreateSecurityGroupRequest = {
10171
10228
  organizationDefault?: boolean;
10172
10229
  /**
10173
10230
  * Whether this security group becomes the default security group for new
10174
- * instances.
10231
+ * Instances.
10175
10232
  *
10176
10233
  * One-of ('defaultIdentifier'): at most one of 'organizationDefault',
10177
10234
  * 'projectDefault' could be set.
@@ -10224,11 +10281,11 @@ type CreateSecurityGroupRuleRequest = {
10224
10281
  direction: SecurityGroupRuleDirection;
10225
10282
  action: SecurityGroupRuleAction;
10226
10283
  ipRange: string;
10227
- /** The beginning of the range of ports to apply this rule to (inclusive). */
10284
+ /** Beginning of the range of ports to apply this rule to (inclusive). */
10228
10285
  destPortFrom?: number;
10229
- /** The end of the range of ports to apply this rule to (inclusive). */
10286
+ /** End of the range of ports to apply this rule to (inclusive). */
10230
10287
  destPortTo?: number;
10231
- /** The position of this rule in the security group rules list. */
10288
+ /** Position of this rule in the security group rules list. */
10232
10289
  position: number;
10233
10290
  /** Indicates if this rule is editable (will be ignored). */
10234
10291
  editable: boolean;
@@ -10263,9 +10320,9 @@ type ListPlacementGroupsRequest = {
10263
10320
  perPage?: number;
10264
10321
  /** A positive integer to choose the page to return. */
10265
10322
  page?: number;
10266
- /** List only placement groups of this organization ID. */
10323
+ /** List only placement groups of this Organization ID. */
10267
10324
  organization?: string;
10268
- /** List only placement groups of this project ID. */
10325
+ /** List only placement groups of this Project ID. */
10269
10326
  project?: string;
10270
10327
  /**
10271
10328
  * List placement groups with these exact tags (to filter with several tags,
@@ -10297,11 +10354,11 @@ type CreatePlacementGroupRequest = {
10297
10354
  * could be set.
10298
10355
  */
10299
10356
  project?: string;
10300
- /** The tags of the placement group. */
10357
+ /** Tags of the placement group. */
10301
10358
  tags?: string[];
10302
- /** The operating mode of the placement group. */
10359
+ /** Operating mode of the placement group. */
10303
10360
  policyMode?: PlacementGroupPolicyMode;
10304
- /** The policy type of the placement group. */
10361
+ /** Policy type of the placement group. */
10305
10362
  policyType?: PlacementGroupPolicyType;
10306
10363
  };
10307
10364
  type GetPlacementGroupRequest = {
@@ -10328,11 +10385,11 @@ type UpdatePlacementGroupRequest = {
10328
10385
  placementGroupId: string;
10329
10386
  /** Name of the placement group. */
10330
10387
  name?: string;
10331
- /** The tags of the placement group. */
10388
+ /** Tags of the placement group. */
10332
10389
  tags?: string[];
10333
- /** The operating mode of the placement group. */
10390
+ /** Operating mode of the placement group. */
10334
10391
  policyMode?: PlacementGroupPolicyMode;
10335
- /** The policy type of the placement group. */
10392
+ /** Policy type of the placement group. */
10336
10393
  policyType?: PlacementGroupPolicyType;
10337
10394
  };
10338
10395
  type DeletePlacementGroupRequest = {
@@ -10344,27 +10401,31 @@ type DeletePlacementGroupRequest = {
10344
10401
  type GetPlacementGroupServersRequest = {
10345
10402
  /** Zone to target. If none is passed will use default zone from the config. */
10346
10403
  zone?: Zone;
10404
+ /** UUID of the placement group you want to get. */
10347
10405
  placementGroupId: string;
10348
10406
  };
10349
10407
  type SetPlacementGroupServersRequest = {
10350
10408
  /** Zone to target. If none is passed will use default zone from the config. */
10351
10409
  zone?: Zone;
10410
+ /** UUID of the placement group you want to set. */
10352
10411
  placementGroupId: string;
10353
- servers?: string[];
10412
+ /** An array of the Instances' UUIDs you want to configure. */
10413
+ servers: string[];
10354
10414
  };
10355
10415
  type UpdatePlacementGroupServersRequest = {
10356
10416
  /** Zone to target. If none is passed will use default zone from the config. */
10357
10417
  zone?: Zone;
10358
- /** UUID of the placement group. */
10418
+ /** UUID of the placement group you want to update. */
10359
10419
  placementGroupId: string;
10420
+ /** An array of the Instances' UUIDs you want to configure. */
10360
10421
  servers: string[];
10361
10422
  };
10362
10423
  type ListIpsRequest = {
10363
10424
  /** Zone to target. If none is passed will use default zone from the config. */
10364
10425
  zone?: Zone;
10365
- /** The project ID the IPs are reserved in. */
10426
+ /** Project ID in which the IPs are reserved. */
10366
10427
  project?: string;
10367
- /** The organization ID the IPs are reserved in. */
10428
+ /** Organization ID in which the IPs are reserved. */
10368
10429
  organization?: string;
10369
10430
  /**
10370
10431
  * Filter IPs with these exact tags (to filter with several tags, use commas
@@ -10385,28 +10446,28 @@ type CreateIpRequest$1 = {
10385
10446
  /** Zone to target. If none is passed will use default zone from the config. */
10386
10447
  zone?: Zone;
10387
10448
  /**
10388
- * @deprecated The organization ID the IP is reserved in.
10449
+ * @deprecated Organization ID in which the IP is reserved.
10389
10450
  *
10390
10451
  * One-of ('projectIdentifier'): at most one of 'organization', 'project'
10391
10452
  * could be set.
10392
10453
  */
10393
10454
  organization?: string;
10394
10455
  /**
10395
- * The project ID the IP is reserved in.
10456
+ * Project ID in which the IP is reserved.
10396
10457
  *
10397
10458
  * One-of ('projectIdentifier'): at most one of 'organization', 'project'
10398
10459
  * could be set.
10399
10460
  */
10400
10461
  project?: string;
10401
- /** The tags of the IP. */
10462
+ /** Tags of the IP. */
10402
10463
  tags?: string[];
10403
- /** UUID of the server you want to attach the IP to. */
10464
+ /** UUID of the Instance you want to attach the IP to. */
10404
10465
  server?: string;
10405
10466
  };
10406
10467
  type GetIpRequest$1 = {
10407
10468
  /** Zone to target. If none is passed will use default zone from the config. */
10408
10469
  zone?: Zone;
10409
- /** The IP ID or address to get. */
10470
+ /** IP ID or address to get. */
10410
10471
  ip: string;
10411
10472
  };
10412
10473
  type UpdateIpRequest$1 = {
@@ -10423,15 +10484,15 @@ type UpdateIpRequest$1 = {
10423
10484
  type DeleteIpRequest = {
10424
10485
  /** Zone to target. If none is passed will use default zone from the config. */
10425
10486
  zone?: Zone;
10426
- /** The ID or the address of the IP to delete. */
10487
+ /** ID or address of the IP to delete. */
10427
10488
  ip: string;
10428
10489
  };
10429
10490
  type ListPrivateNICsRequest = {
10430
10491
  /** Zone to target. If none is passed will use default zone from the config. */
10431
10492
  zone?: Zone;
10432
- /** The server the private NIC is attached to. */
10493
+ /** Instance to which the private NIC is attached. */
10433
10494
  serverId: string;
10434
- /** The private NIC tags. */
10495
+ /** Private NIC tags. */
10435
10496
  tags?: string[];
10436
10497
  /**
10437
10498
  * A positive integer lower or equal to 100 to select the number of items to
@@ -10444,27 +10505,27 @@ type ListPrivateNICsRequest = {
10444
10505
  type CreatePrivateNICRequest = {
10445
10506
  /** Zone to target. If none is passed will use default zone from the config. */
10446
10507
  zone?: Zone;
10447
- /** UUID of the server the private NIC will be attached to. */
10508
+ /** UUID of the Instance the private NIC will be attached to. */
10448
10509
  serverId: string;
10449
10510
  /** UUID of the private network where the private NIC will be attached. */
10450
10511
  privateNetworkId: string;
10451
- /** The private NIC tags. */
10512
+ /** Private NIC tags. */
10452
10513
  tags?: string[];
10453
10514
  };
10454
10515
  type GetPrivateNICRequest = {
10455
10516
  /** Zone to target. If none is passed will use default zone from the config. */
10456
10517
  zone?: Zone;
10457
- /** The server the private NIC is attached to. */
10518
+ /** Instance to which the private NIC is attached. */
10458
10519
  serverId: string;
10459
- /** The private NIC unique ID. */
10520
+ /** Private NIC unique ID. */
10460
10521
  privateNicId: string;
10461
10522
  };
10462
10523
  type UpdatePrivateNICRequest = {
10463
10524
  /** Zone to target. If none is passed will use default zone from the config. */
10464
10525
  zone?: Zone;
10465
- /** UUID of the server the private NIC will be attached to. */
10526
+ /** UUID of the Instance the private NIC will be attached to. */
10466
10527
  serverId: string;
10467
- /** The private NIC unique ID. */
10528
+ /** Private NIC unique ID. */
10468
10529
  privateNicId: string;
10469
10530
  /** Tags used to select private NIC/s. */
10470
10531
  tags?: string[];
@@ -10472,9 +10533,9 @@ type UpdatePrivateNICRequest = {
10472
10533
  type DeletePrivateNICRequest = {
10473
10534
  /** Zone to target. If none is passed will use default zone from the config. */
10474
10535
  zone?: Zone;
10475
- /** The server the private NIC is attached to. */
10536
+ /** Instance to which the private NIC is attached. */
10476
10537
  serverId: string;
10477
- /** The private NIC unique ID. */
10538
+ /** Private NIC unique ID. */
10478
10539
  privateNicId: string;
10479
10540
  };
10480
10541
  type ListBootscriptsRequest = {
@@ -10522,117 +10583,117 @@ interface SetSnapshotResponse {
10522
10583
  type CreateServerRequest = {
10523
10584
  /** Zone to target. If none is passed will use default zone from the config. */
10524
10585
  zone?: Zone;
10525
- /** The server name. */
10586
+ /** Instance name. */
10526
10587
  name?: string;
10527
- /** Define if a dynamic IP is required for the instance. */
10588
+ /** Define if a dynamic IP is required for the Instance. */
10528
10589
  dynamicIpRequired?: boolean;
10529
- /** Define the server commercial type (i.e. GP1-S). */
10590
+ /** Define the Instance commercial type (i.e. GP1-S). */
10530
10591
  commercialType: string;
10531
- /** The server image ID or label. */
10592
+ /** Instance image ID or label. */
10532
10593
  image: string;
10533
- /** The volumes attached to the server. */
10594
+ /** Volumes attached to the server. */
10534
10595
  volumes?: Record<string, VolumeServerTemplate>;
10535
10596
  /** True if IPv6 is enabled on the server. */
10536
10597
  enableIpv6: boolean;
10537
- /** The ID of the reserved IP to attach to the server. */
10598
+ /** ID of the reserved IP to attach to the server. */
10538
10599
  publicIp?: string;
10539
- /** The boot type to use. */
10600
+ /** Boot type to use. */
10540
10601
  bootType?: BootType;
10541
- /**
10542
- * @deprecated The bootscript ID to use when `boot_type` is set to
10543
- * `bootscript`.
10544
- */
10602
+ /** @deprecated Bootscript ID to use when `boot_type` is set to `bootscript`. */
10545
10603
  bootscript?: string;
10546
10604
  /**
10547
- * @deprecated The server organization ID.
10605
+ * @deprecated Instance Organization ID.
10548
10606
  *
10549
10607
  * One-of ('projectIdentifier'): at most one of 'organization', 'project'
10550
10608
  * could be set.
10551
10609
  */
10552
10610
  organization?: string;
10553
10611
  /**
10554
- * The server project ID.
10612
+ * Instance Project ID.
10555
10613
  *
10556
10614
  * One-of ('projectIdentifier'): at most one of 'organization', 'project'
10557
10615
  * could be set.
10558
10616
  */
10559
10617
  project?: string;
10560
- /** The server tags. */
10618
+ /** Instance tags. */
10561
10619
  tags?: string[];
10562
- /** The security group ID. */
10620
+ /** Security group ID. */
10563
10621
  securityGroup?: string;
10564
- /** Placement group ID if server must be part of a placement group. */
10622
+ /** Placement group ID if Instance must be part of a placement group. */
10565
10623
  placementGroup?: string;
10566
10624
  };
10567
10625
  type SetServerRequest = {
10568
10626
  /** Zone to target. If none is passed will use default zone from the config. */
10569
10627
  zone?: Zone;
10570
- /** The server unique ID. */
10628
+ /** Instance unique ID. */
10571
10629
  id: string;
10572
- /** The server name. */
10630
+ /** Instance name. */
10573
10631
  name: string;
10574
- /** The server organization ID. */
10632
+ /** Instance Organization ID. */
10575
10633
  organization?: string;
10576
- /** The server project ID. */
10634
+ /** Instance Project ID. */
10577
10635
  project?: string;
10578
- /** Provide as list of allowed actions on the server. */
10636
+ /** Provide a list of allowed actions on the server. */
10579
10637
  allowedActions?: ServerAction[];
10580
- /** The server associated tags. */
10638
+ /** Tags associated with the Instance. */
10581
10639
  tags?: string[];
10582
- /** The server commercial type (eg. GP1-M). */
10640
+ /** Instance commercial type (eg. GP1-M). */
10583
10641
  commercialType: string;
10584
- /** The server creation date. */
10642
+ /** Instance creation date. */
10585
10643
  creationDate?: Date;
10586
10644
  /** True if a dynamic IP is required. */
10587
10645
  dynamicIpRequired: boolean;
10588
10646
  /** True if IPv6 is enabled. */
10589
10647
  enableIpv6: boolean;
10590
- /** The server host name. */
10648
+ /** Instance host name. */
10591
10649
  hostname: string;
10592
- /** Provide information on the server image. */
10650
+ /** Provide information on the Instance image. */
10593
10651
  image?: Image$3;
10594
- /** The server protection option is activated. */
10652
+ /** Instance protection option is activated. */
10595
10653
  protected: boolean;
10596
- /** The server private IP address. */
10654
+ /** Instance private IP address. */
10597
10655
  privateIp?: string;
10598
10656
  /** Information about the public IP. */
10599
10657
  publicIp?: ServerIp;
10600
- /** The server modification date. */
10658
+ /** Instance modification date. */
10601
10659
  modificationDate?: Date;
10602
- /** The server state. */
10660
+ /** Instance state. */
10603
10661
  state?: ServerState;
10604
- /** The server location. */
10662
+ /** Instance location. */
10605
10663
  location?: ServerLocation;
10606
- /** The server IPv6 address. */
10664
+ /** Instance IPv6 address. */
10607
10665
  ipv6?: ServerIpv6;
10608
- /** @deprecated The server bootscript. */
10666
+ /** @deprecated Instance bootscript. */
10609
10667
  bootscript?: Bootscript;
10610
- /** The server boot type. */
10668
+ /** Instance boot type. */
10611
10669
  bootType?: BootType;
10612
- /** The server volumes. */
10670
+ /** Instance volumes. */
10613
10671
  volumes?: Record<string, Volume$1>;
10614
- /** The server security group. */
10672
+ /** Instance security group. */
10615
10673
  securityGroup?: SecurityGroupSummary;
10616
- /** The server planned maintenances. */
10674
+ /** Instance planned maintenances. */
10617
10675
  maintenances?: ServerMaintenance[];
10618
- /** The server state_detail. */
10676
+ /** Instance state_detail. */
10619
10677
  stateDetail: string;
10620
- /** The server arch. */
10678
+ /**
10679
+ * Instance architecture (refers to the CPU architecture used for the
10680
+ * Instance, e.g. x86_64, arm64).
10681
+ */
10621
10682
  arch?: Arch;
10622
- /** The server placement group. */
10683
+ /** Instance placement group. */
10623
10684
  placementGroup?: PlacementGroup;
10624
- /** The server private NICs. */
10685
+ /** Instance private NICs. */
10625
10686
  privateNics?: PrivateNIC[];
10626
10687
  };
10627
10688
  type UpdateServerRequest = {
10628
10689
  /** Zone to target. If none is passed will use default zone from the config. */
10629
10690
  zone?: Zone;
10630
- /** UUID of the server. */
10691
+ /** UUID of the Instance. */
10631
10692
  serverId: string;
10632
- /** Name of the server. */
10693
+ /** Name of the Instance. */
10633
10694
  name?: string;
10634
10695
  bootType?: BootType;
10635
- /** Tags of the server. */
10696
+ /** Tags of the Instance. */
10636
10697
  tags?: string[];
10637
10698
  volumes?: Record<string, VolumeServerTemplate>;
10638
10699
  /** @deprecated */
@@ -10641,9 +10702,9 @@ type UpdateServerRequest = {
10641
10702
  enableIpv6?: boolean;
10642
10703
  protected?: boolean;
10643
10704
  securityGroup?: SecurityGroupTemplate;
10644
- /** Placement group ID if server must be part of a placement group. */
10705
+ /** Placement group ID if Instance must be part of a placement group. */
10645
10706
  placementGroup?: string | null;
10646
- /** The server private NICs. */
10707
+ /** Instance private NICs. */
10647
10708
  privateNics?: PrivateNIC[];
10648
10709
  };
10649
10710
  type SetImageRequest = {
@@ -10684,33 +10745,33 @@ type SetSnapshotRequest = {
10684
10745
  type SetSecurityGroupRequest = {
10685
10746
  /** Zone to target. If none is passed will use default zone from the config. */
10686
10747
  zone?: Zone;
10687
- /** The ID of the security group (will be ignored). */
10748
+ /** ID of the security group (will be ignored). */
10688
10749
  id: string;
10689
- /** The name of the security group. */
10750
+ /** Name of the security group. */
10690
10751
  name: string;
10691
- /** The tags of the security group. */
10752
+ /** Tags of the security group. */
10692
10753
  tags?: string[];
10693
- /** The creation date of the security group (will be ignored). */
10754
+ /** Creation date of the security group (will be ignored). */
10694
10755
  creationDate?: Date;
10695
- /** The modification date of the security group (will be ignored). */
10756
+ /** Modification date of the security group (will be ignored). */
10696
10757
  modificationDate?: Date;
10697
- /** The description of the security group. */
10758
+ /** Description of the security group. */
10698
10759
  description: string;
10699
10760
  /** True to block SMTP on IPv4 and IPv6. */
10700
10761
  enableDefaultSecurity: boolean;
10701
- /** The default inbound policy. */
10762
+ /** Default inbound policy. */
10702
10763
  inboundDefaultPolicy?: SecurityGroupPolicy;
10703
- /** The default outbound policy. */
10764
+ /** Default outbound policy. */
10704
10765
  outboundDefaultPolicy?: SecurityGroupPolicy;
10705
- /** The security groups organization ID. */
10766
+ /** Security groups Organization ID. */
10706
10767
  organization?: string;
10707
- /** The security group project ID. */
10768
+ /** Security group Project ID. */
10708
10769
  project?: string;
10709
10770
  /** @deprecated Please use project_default instead. */
10710
10771
  organizationDefault?: boolean;
10711
- /** True use this security group for future instances created in this project. */
10772
+ /** True use this security group for future Instances created in this project. */
10712
10773
  projectDefault: boolean;
10713
- /** The servers attached to this security group. */
10774
+ /** Instances attached to this security group. */
10714
10775
  servers?: ServerSummary[];
10715
10776
  /** True to set the security group as stateful. */
10716
10777
  stateful: boolean;
@@ -10736,21 +10797,22 @@ declare class API$f extends API$q {
10736
10797
  /** Lists the available zones of the API. */
10737
10798
  static readonly LOCALITIES: Zone[];
10738
10799
  /**
10739
- * Get availability. Get availability for all server types.
10800
+ * Get availability. Get availability for all Instance types.
10740
10801
  *
10741
10802
  * @param request - The request {@link GetServerTypesAvailabilityRequest}
10742
10803
  * @returns A Promise of GetServerTypesAvailabilityResponse
10743
10804
  */
10744
10805
  getServerTypesAvailability: (request?: Readonly<GetServerTypesAvailabilityRequest>) => Promise<GetServerTypesAvailabilityResponse>;
10745
10806
  /**
10746
- * List server types. Get server types technical details.
10807
+ * List Instance types. List available Instance types and their technical
10808
+ * details.
10747
10809
  *
10748
10810
  * @param request - The request {@link ListServersTypesRequest}
10749
10811
  * @returns A Promise of ListServersTypesResponse
10750
10812
  */
10751
10813
  listServersTypes: (request?: Readonly<ListServersTypesRequest>) => Promise<ListServersTypesResponse>;
10752
10814
  /**
10753
- * List volumes types. Get volumes technical details.
10815
+ * List volumes types. List all volume types and their technical details.
10754
10816
  *
10755
10817
  * @param request - The request {@link ListVolumesTypesRequest}
10756
10818
  * @returns A Promise of ListVolumesTypesResponse
@@ -10758,7 +10820,8 @@ declare class API$f extends API$q {
10758
10820
  listVolumesTypes: (request?: Readonly<ListVolumesTypesRequest>) => Promise<ListVolumesTypesResponse>;
10759
10821
  protected pageOfListServers: (request?: Readonly<ListServersRequest>) => Promise<ListServersResponse>;
10760
10822
  /**
10761
- * List all servers.
10823
+ * List all Instances. List all Instances in a specified Availability Zone,
10824
+ * e.g. `fr-par-1`.
10762
10825
  *
10763
10826
  * @param request - The request {@link ListServersRequest}
10764
10827
  * @returns A Promise of ListServersResponse
@@ -10769,13 +10832,13 @@ declare class API$f extends API$q {
10769
10832
  };
10770
10833
  protected _createServer: (request: Readonly<CreateServerRequest>) => Promise<CreateServerResponse>;
10771
10834
  /**
10772
- * Delete a server. Delete a server with the given ID.
10835
+ * Delete an Instance. Delete the Instance with the specified ID.
10773
10836
  *
10774
10837
  * @param request - The request {@link DeleteServerRequest}
10775
10838
  */
10776
10839
  deleteServer: (request: Readonly<DeleteServerRequest>) => Promise<void>;
10777
10840
  /**
10778
- * Get a server. Get the details of a specified Server.
10841
+ * Get an Instance. Get the details of a specified Instance.
10779
10842
  *
10780
10843
  * @param request - The request {@link GetServerRequest}
10781
10844
  * @returns A Promise of GetServerResponse
@@ -10784,42 +10847,48 @@ declare class API$f extends API$q {
10784
10847
  protected _setServer: (request: Readonly<SetServerRequest>) => Promise<SetServerResponse>;
10785
10848
  protected _updateServer: (request: Readonly<UpdateServerRequest>) => Promise<UpdateServerResponse>;
10786
10849
  /**
10787
- * List server actions. List all actions that can currently be performed on a
10788
- * server.
10850
+ * List Instance actions. List all actions (e.g. power on, power off, reboot)
10851
+ * that can currently be performed on an Instance.
10789
10852
  *
10790
10853
  * @param request - The request {@link ListServerActionsRequest}
10791
10854
  * @returns A Promise of ListServerActionsResponse
10792
10855
  */
10793
10856
  listServerActions: (request: Readonly<ListServerActionsRequest>) => Promise<ListServerActionsResponse>;
10794
10857
  /**
10795
- * Perform action. Perform power related actions on a server. Be wary that
10796
- * when terminating a server, all the attached volumes (local _and_ block
10797
- * storage) are deleted. So, if you want to keep your local volumes, you must
10798
- * use the `archive` action instead of `terminate`. And if you want to keep
10799
- * block-storage volumes, **you must** detach it beforehand you issue the
10800
- * `terminate` call. For more information, read the [Volumes](#volumes-7e8a39)
10801
- * documentation.
10858
+ * Perform action. Perform an action on an Instance. Available actions are:
10859
+ * `poweron`: Start a stopped Instance. `poweroff`: Fully stop the Instance
10860
+ * and release the hypervisor slot. `stop_in_place`: Stop the Instance, but
10861
+ * keep the slot on the hypervisor. `reboot`: Stop the instance and restart
10862
+ * it. `backup`: Create an image with all the volumes of an Instance.
10863
+ * `terminate`: Delete the Instance along with all attached volumes.
10864
+ *
10865
+ * Keep in mind that terminating an Instance will result in the deletion of
10866
+ * all attached volumes, including local and block storage. If you want to
10867
+ * preserve your local volumes, you should use the `archive` action instead of
10868
+ * `terminate`. Similarly, if you want to keep your block storage volumes, you
10869
+ * must first detach them before issuing the `terminate` command. For more
10870
+ * information, read the [Volumes](#volumes-7e8a39) documentation.
10802
10871
  *
10803
10872
  * @param request - The request {@link ServerActionRequest}
10804
10873
  * @returns A Promise of ServerActionResponse
10805
10874
  */
10806
10875
  serverAction: (request: Readonly<ServerActionRequest>) => Promise<ServerActionResponse>;
10807
10876
  /**
10808
- * List user data. List all user data keys registered on a given server.
10877
+ * List user data. List all user data keys registered on a specified Instance.
10809
10878
  *
10810
10879
  * @param request - The request {@link ListServerUserDataRequest}
10811
10880
  * @returns A Promise of ListServerUserDataResponse
10812
10881
  */
10813
10882
  listServerUserData: (request: Readonly<ListServerUserDataRequest>) => Promise<ListServerUserDataResponse>;
10814
10883
  /**
10815
- * Delete user data. Delete the given key from a server user data.
10884
+ * Delete user data. Delete the specified key from an Instance's user data.
10816
10885
  *
10817
10886
  * @param request - The request {@link DeleteServerUserDataRequest}
10818
10887
  */
10819
10888
  deleteServerUserData: (request: Readonly<DeleteServerUserDataRequest>) => Promise<void>;
10820
10889
  protected pageOfListImages: (request?: Readonly<ListImagesRequest$3>) => Promise<ListImagesResponse$3>;
10821
10890
  /**
10822
- * List instance images. List all images available in an account.
10891
+ * List Instance images. List all existing Instance images.
10823
10892
  *
10824
10893
  * @param request - The request {@link ListImagesRequest}
10825
10894
  * @returns A Promise of ListImagesResponse
@@ -10829,14 +10898,15 @@ declare class API$f extends API$q {
10829
10898
  [Symbol.asyncIterator]: () => AsyncGenerator<Image$3[], void, void>;
10830
10899
  };
10831
10900
  /**
10832
- * Get an instance image. Get details of an image with the given ID.
10901
+ * Get an Instance image. Get details of an image with the specified ID.
10833
10902
  *
10834
10903
  * @param request - The request {@link GetImageRequest}
10835
10904
  * @returns A Promise of GetImageResponse
10836
10905
  */
10837
10906
  getImage: (request: Readonly<GetImageRequest$3>) => Promise<GetImageResponse$1>;
10838
10907
  /**
10839
- * Create an instance image.
10908
+ * Create an Instance image. Create an Instance image from the specified
10909
+ * snapshot ID.
10840
10910
  *
10841
10911
  * @param request - The request {@link CreateImageRequest}
10842
10912
  * @returns A Promise of CreateImageResponse
@@ -10844,14 +10914,15 @@ declare class API$f extends API$q {
10844
10914
  createImage: (request: Readonly<CreateImageRequest>) => Promise<CreateImageResponse>;
10845
10915
  protected _setImage: (request: Readonly<SetImageRequest>) => Promise<SetImageResponse>;
10846
10916
  /**
10847
- * Delete an instance image. Delete the image with the given ID.
10917
+ * Delete an Instance image. Delete the image with the specified ID.
10848
10918
  *
10849
10919
  * @param request - The request {@link DeleteImageRequest}
10850
10920
  */
10851
10921
  deleteImage: (request: Readonly<DeleteImageRequest$1>) => Promise<void>;
10852
10922
  protected pageOfListSnapshots: (request?: Readonly<ListSnapshotsRequest$1>) => Promise<ListSnapshotsResponse$1>;
10853
10923
  /**
10854
- * List snapshots.
10924
+ * List snapshots. List all snapshots of an Organization in a specified
10925
+ * Availability Zone.
10855
10926
  *
10856
10927
  * @param request - The request {@link ListSnapshotsRequest}
10857
10928
  * @returns A Promise of ListSnapshotsResponse
@@ -10861,14 +10932,16 @@ declare class API$f extends API$q {
10861
10932
  [Symbol.asyncIterator]: () => AsyncGenerator<Snapshot$1[], void, void>;
10862
10933
  };
10863
10934
  /**
10864
- * Create a snapshot from a given volume or from a QCOW2 file.
10935
+ * Create a snapshot from a specified volume or from a QCOW2 file. Create a
10936
+ * snapshot from a specified volume or from a QCOW2 file in a specified
10937
+ * Availability Zone.
10865
10938
  *
10866
10939
  * @param request - The request {@link CreateSnapshotRequest}
10867
10940
  * @returns A Promise of CreateSnapshotResponse
10868
10941
  */
10869
10942
  createSnapshot: (request?: Readonly<CreateSnapshotRequest$1>) => Promise<CreateSnapshotResponse>;
10870
10943
  /**
10871
- * Get a snapshot. Get details of a snapshot with the given ID.
10944
+ * Get a snapshot. Get details of a snapshot with the specified ID.
10872
10945
  *
10873
10946
  * @param request - The request {@link GetSnapshotRequest}
10874
10947
  * @returns A Promise of GetSnapshotResponse
@@ -10876,13 +10949,13 @@ declare class API$f extends API$q {
10876
10949
  getSnapshot: (request: Readonly<GetSnapshotRequest$1>) => Promise<GetSnapshotResponse>;
10877
10950
  protected _setSnapshot: (request: Readonly<SetSnapshotRequest>) => Promise<SetSnapshotResponse>;
10878
10951
  /**
10879
- * Delete a snapshot. Delete the snapshot with the given ID.
10952
+ * Delete a snapshot. Delete the snapshot with the specified ID.
10880
10953
  *
10881
10954
  * @param request - The request {@link DeleteSnapshotRequest}
10882
10955
  */
10883
10956
  deleteSnapshot: (request: Readonly<DeleteSnapshotRequest$1>) => Promise<void>;
10884
10957
  /**
10885
- * Export a snapshot. Export a snapshot to a given S3 bucket in the same
10958
+ * Export a snapshot. Export a snapshot to a specified S3 bucket in the same
10886
10959
  * region.
10887
10960
  *
10888
10961
  * @param request - The request {@link ExportSnapshotRequest}
@@ -10891,7 +10964,8 @@ declare class API$f extends API$q {
10891
10964
  exportSnapshot: (request: Readonly<ExportSnapshotRequest>) => Promise<ExportSnapshotResponse>;
10892
10965
  protected pageOfListVolumes: (request?: Readonly<ListVolumesRequest>) => Promise<ListVolumesResponse>;
10893
10966
  /**
10894
- * List volumes.
10967
+ * List volumes. List volumes in the specified Availability Zone. You can
10968
+ * filter the output by volume type.
10895
10969
  *
10896
10970
  * @param request - The request {@link ListVolumesRequest}
10897
10971
  * @returns A Promise of ListVolumesResponse
@@ -10901,37 +10975,38 @@ declare class API$f extends API$q {
10901
10975
  [Symbol.asyncIterator]: () => AsyncGenerator<Volume$1[], void, void>;
10902
10976
  };
10903
10977
  /**
10904
- * Create a volume.
10978
+ * Create a volume. Create a volume of a specified type in an Availability
10979
+ * Zone.
10905
10980
  *
10906
10981
  * @param request - The request {@link CreateVolumeRequest}
10907
10982
  * @returns A Promise of CreateVolumeResponse
10908
10983
  */
10909
10984
  createVolume: (request?: Readonly<CreateVolumeRequest>) => Promise<CreateVolumeResponse>;
10910
10985
  /**
10911
- * Get a volume. Get details of a volume with the given ID.
10986
+ * Get a volume. Get details of a volume with the specified ID.
10912
10987
  *
10913
10988
  * @param request - The request {@link GetVolumeRequest}
10914
10989
  * @returns A Promise of GetVolumeResponse
10915
10990
  */
10916
10991
  getVolume: (request: Readonly<GetVolumeRequest>) => Promise<GetVolumeResponse>;
10917
10992
  /**
10918
- * Update a volume. Replace name and/or size properties of given ID volume
10919
- * with the given value(s). Any volume name can be changed while, for now,
10920
- * only `b_ssd` volume growing is supported.
10993
+ * Update a volume. Replace the name and/or size properties of a volume
10994
+ * specified by its ID, with the specified value(s). Any volume name can be
10995
+ * changed, however only `b_ssd` volumes can currently be increased in size.
10921
10996
  *
10922
10997
  * @param request - The request {@link UpdateVolumeRequest}
10923
10998
  * @returns A Promise of UpdateVolumeResponse
10924
10999
  */
10925
11000
  updateVolume: (request: Readonly<UpdateVolumeRequest>) => Promise<UpdateVolumeResponse>;
10926
11001
  /**
10927
- * Delete a volume. Delete the volume with the given ID.
11002
+ * Delete a volume. Delete the volume with the specified ID.
10928
11003
  *
10929
11004
  * @param request - The request {@link DeleteVolumeRequest}
10930
11005
  */
10931
11006
  deleteVolume: (request: Readonly<DeleteVolumeRequest>) => Promise<void>;
10932
11007
  protected pageOfListSecurityGroups: (request?: Readonly<ListSecurityGroupsRequest>) => Promise<ListSecurityGroupsResponse>;
10933
11008
  /**
10934
- * List security groups. List all security groups available in an account.
11009
+ * List security groups. List all existing security groups.
10935
11010
  *
10936
11011
  * @param request - The request {@link ListSecurityGroupsRequest}
10937
11012
  * @returns A Promise of ListSecurityGroupsResponse
@@ -10941,22 +11016,23 @@ declare class API$f extends API$q {
10941
11016
  [Symbol.asyncIterator]: () => AsyncGenerator<SecurityGroup[], void, void>;
10942
11017
  };
10943
11018
  /**
10944
- * Create a security group.
11019
+ * Create a security group. Create a security group with a specified name and
11020
+ * description.
10945
11021
  *
10946
11022
  * @param request - The request {@link CreateSecurityGroupRequest}
10947
11023
  * @returns A Promise of CreateSecurityGroupResponse
10948
11024
  */
10949
11025
  createSecurityGroup: (request: Readonly<CreateSecurityGroupRequest>) => Promise<CreateSecurityGroupResponse>;
10950
11026
  /**
10951
- * Get a security group. Get the details of a Security Group with the given
10952
- * ID.
11027
+ * Get a security group. Get the details of a security group with the
11028
+ * specified ID.
10953
11029
  *
10954
11030
  * @param request - The request {@link GetSecurityGroupRequest}
10955
11031
  * @returns A Promise of GetSecurityGroupResponse
10956
11032
  */
10957
11033
  getSecurityGroup: (request: Readonly<GetSecurityGroupRequest>) => Promise<GetSecurityGroupResponse>;
10958
11034
  /**
10959
- * Delete a security group.
11035
+ * Delete a security group. Delete a security group with the specified ID.
10960
11036
  *
10961
11037
  * @param request - The request {@link DeleteSecurityGroupRequest}
10962
11038
  */
@@ -10972,7 +11048,7 @@ declare class API$f extends API$q {
10972
11048
  listDefaultSecurityGroupRules: (request?: Readonly<ListDefaultSecurityGroupRulesRequest>) => Promise<ListSecurityGroupRulesResponse>;
10973
11049
  protected pageOfListSecurityGroupRules: (request: Readonly<ListSecurityGroupRulesRequest>) => Promise<ListSecurityGroupRulesResponse>;
10974
11050
  /**
10975
- * List rules.
11051
+ * List rules. List the rules of the a specified security group ID.
10976
11052
  *
10977
11053
  * @param request - The request {@link ListSecurityGroupRulesRequest}
10978
11054
  * @returns A Promise of ListSecurityGroupRulesResponse
@@ -10982,30 +11058,30 @@ declare class API$f extends API$q {
10982
11058
  [Symbol.asyncIterator]: () => AsyncGenerator<SecurityGroupRule[], void, void>;
10983
11059
  };
10984
11060
  /**
10985
- * Create rule.
11061
+ * Create rule. Create a rule in the specified security group ID.
10986
11062
  *
10987
11063
  * @param request - The request {@link CreateSecurityGroupRuleRequest}
10988
11064
  * @returns A Promise of CreateSecurityGroupRuleResponse
10989
11065
  */
10990
11066
  createSecurityGroupRule: (request: Readonly<CreateSecurityGroupRuleRequest>) => Promise<CreateSecurityGroupRuleResponse>;
10991
11067
  /**
10992
- * Update all the rules of a security group. Replaces the rules of the
10993
- * security group with the rules provided. This endpoint supports the update
10994
- * of existing rules, creation of new rules and deletion of existing rules
10995
- * when they are not passed in the request.
11068
+ * Update all the rules of a security group. Replaces the existing rules of
11069
+ * the security group with the rules provided. This endpoint supports the
11070
+ * update of existing rules, creation of new rules and deletion of existing
11071
+ * rules when they are not passed in the request.
10996
11072
  *
10997
11073
  * @param request - The request {@link SetSecurityGroupRulesRequest}
10998
11074
  * @returns A Promise of SetSecurityGroupRulesResponse
10999
11075
  */
11000
11076
  setSecurityGroupRules: (request: Readonly<SetSecurityGroupRulesRequest>) => Promise<SetSecurityGroupRulesResponse>;
11001
11077
  /**
11002
- * Delete rule. Delete a security group rule with the given ID.
11078
+ * Delete rule. Delete a security group rule with the specified ID.
11003
11079
  *
11004
11080
  * @param request - The request {@link DeleteSecurityGroupRuleRequest}
11005
11081
  */
11006
11082
  deleteSecurityGroupRule: (request: Readonly<DeleteSecurityGroupRuleRequest>) => Promise<void>;
11007
11083
  /**
11008
- * Get rule. Get details of a security group rule with the given ID.
11084
+ * Get rule. Get details of a security group rule with the specified ID.
11009
11085
  *
11010
11086
  * @param request - The request {@link GetSecurityGroupRuleRequest}
11011
11087
  * @returns A Promise of GetSecurityGroupRuleResponse
@@ -11014,7 +11090,8 @@ declare class API$f extends API$q {
11014
11090
  protected _setSecurityGroupRule: (request: Readonly<SetSecurityGroupRuleRequest>) => Promise<SetSecurityGroupRuleResponse>;
11015
11091
  protected pageOfListPlacementGroups: (request?: Readonly<ListPlacementGroupsRequest>) => Promise<ListPlacementGroupsResponse>;
11016
11092
  /**
11017
- * List placement groups. List all placement groups.
11093
+ * List placement groups. List all placement groups in a specified
11094
+ * Availability Zone.
11018
11095
  *
11019
11096
  * @param request - The request {@link ListPlacementGroupsRequest}
11020
11097
  * @returns A Promise of ListPlacementGroupsResponse
@@ -11024,28 +11101,29 @@ declare class API$f extends API$q {
11024
11101
  [Symbol.asyncIterator]: () => AsyncGenerator<PlacementGroup[], void, void>;
11025
11102
  };
11026
11103
  /**
11027
- * Create a placement group. Create a new placement group.
11104
+ * Create a placement group. Create a new placement group in a specified
11105
+ * Availability Zone.
11028
11106
  *
11029
11107
  * @param request - The request {@link CreatePlacementGroupRequest}
11030
11108
  * @returns A Promise of CreatePlacementGroupResponse
11031
11109
  */
11032
11110
  createPlacementGroup: (request?: Readonly<CreatePlacementGroupRequest>) => Promise<CreatePlacementGroupResponse>;
11033
11111
  /**
11034
- * Get a placement group. Get the given placement group.
11112
+ * Get a placement group. Get the specified placement group.
11035
11113
  *
11036
11114
  * @param request - The request {@link GetPlacementGroupRequest}
11037
11115
  * @returns A Promise of GetPlacementGroupResponse
11038
11116
  */
11039
11117
  getPlacementGroup: (request: Readonly<GetPlacementGroupRequest>) => Promise<GetPlacementGroupResponse>;
11040
11118
  /**
11041
- * Set placement group. Set all parameters of the given placement group.
11119
+ * Set placement group. Set all parameters of the specified placement group.
11042
11120
  *
11043
11121
  * @param request - The request {@link SetPlacementGroupRequest}
11044
11122
  * @returns A Promise of SetPlacementGroupResponse
11045
11123
  */
11046
11124
  setPlacementGroup: (request: Readonly<SetPlacementGroupRequest>) => Promise<SetPlacementGroupResponse>;
11047
11125
  /**
11048
- * Update a placement group. Update one or more parameter of the given
11126
+ * Update a placement group. Update one or more parameter of the specified
11049
11127
  * placement group.
11050
11128
  *
11051
11129
  * @param request - The request {@link UpdatePlacementGroupRequest}
@@ -11053,13 +11131,13 @@ declare class API$f extends API$q {
11053
11131
  */
11054
11132
  updatePlacementGroup: (request: Readonly<UpdatePlacementGroupRequest>) => Promise<UpdatePlacementGroupResponse>;
11055
11133
  /**
11056
- * Delete the given placement group.
11134
+ * Delete the specified placement group.
11057
11135
  *
11058
11136
  * @param request - The request {@link DeletePlacementGroupRequest}
11059
11137
  */
11060
11138
  deletePlacementGroup: (request: Readonly<DeletePlacementGroupRequest>) => Promise<void>;
11061
11139
  /**
11062
- * Get placement group servers. Get all servers belonging to the given
11140
+ * Get placement group servers. Get all Instances belonging to the specified
11063
11141
  * placement group.
11064
11142
  *
11065
11143
  * @param request - The request {@link GetPlacementGroupServersRequest}
@@ -11067,7 +11145,7 @@ declare class API$f extends API$q {
11067
11145
  */
11068
11146
  getPlacementGroupServers: (request: Readonly<GetPlacementGroupServersRequest>) => Promise<GetPlacementGroupServersResponse>;
11069
11147
  /**
11070
- * Set placement group servers. Set all servers belonging to the given
11148
+ * Set placement group servers. Set all Instances belonging to the specified
11071
11149
  * placement group.
11072
11150
  *
11073
11151
  * @param request - The request {@link SetPlacementGroupServersRequest}
@@ -11075,8 +11153,8 @@ declare class API$f extends API$q {
11075
11153
  */
11076
11154
  setPlacementGroupServers: (request: Readonly<SetPlacementGroupServersRequest>) => Promise<SetPlacementGroupServersResponse>;
11077
11155
  /**
11078
- * Update placement group servers. Update all servers belonging to the given
11079
- * placement group.
11156
+ * Update placement group servers. Update all Instances belonging to the
11157
+ * specified placement group.
11080
11158
  *
11081
11159
  * @param request - The request {@link UpdatePlacementGroupServersRequest}
11082
11160
  * @returns A Promise of UpdatePlacementGroupServersResponse
@@ -11084,7 +11162,7 @@ declare class API$f extends API$q {
11084
11162
  updatePlacementGroupServers: (request: Readonly<UpdatePlacementGroupServersRequest>) => Promise<UpdatePlacementGroupServersResponse>;
11085
11163
  protected pageOfListIps: (request?: Readonly<ListIpsRequest>) => Promise<ListIpsResponse$1>;
11086
11164
  /**
11087
- * List all flexible IPs.
11165
+ * List all flexible IPs. List all flexible IPs in a specified zone.
11088
11166
  *
11089
11167
  * @param request - The request {@link ListIpsRequest}
11090
11168
  * @returns A Promise of ListIpsResponse
@@ -11094,35 +11172,37 @@ declare class API$f extends API$q {
11094
11172
  [Symbol.asyncIterator]: () => AsyncGenerator<Ip$1[], void, void>;
11095
11173
  };
11096
11174
  /**
11097
- * Reserve a flexible IP.
11175
+ * Reserve a flexible IP. Reserve a flexible IP and attach it to the specified
11176
+ * Instance.
11098
11177
  *
11099
11178
  * @param request - The request {@link CreateIpRequest}
11100
11179
  * @returns A Promise of CreateIpResponse
11101
11180
  */
11102
11181
  createIp: (request?: Readonly<CreateIpRequest$1>) => Promise<CreateIpResponse>;
11103
11182
  /**
11104
- * Get a flexible IP. Get details of an IP with the given ID or address.
11183
+ * Get a flexible IP. Get details of an IP with the specified ID or address.
11105
11184
  *
11106
11185
  * @param request - The request {@link GetIpRequest}
11107
11186
  * @returns A Promise of GetIpResponse
11108
11187
  */
11109
11188
  getIp: (request: Readonly<GetIpRequest$1>) => Promise<GetIpResponse>;
11110
11189
  /**
11111
- * Update a flexible IP.
11190
+ * Update a flexible IP. Update a flexible IP in the specified zone with the
11191
+ * specified ID.
11112
11192
  *
11113
11193
  * @param request - The request {@link UpdateIpRequest}
11114
11194
  * @returns A Promise of UpdateIpResponse
11115
11195
  */
11116
11196
  updateIp: (request: Readonly<UpdateIpRequest$1>) => Promise<UpdateIpResponse>;
11117
11197
  /**
11118
- * Delete a flexible IP. Delete the IP with the given ID.
11198
+ * Delete a flexible IP. Delete the IP with the specified ID.
11119
11199
  *
11120
11200
  * @param request - The request {@link DeleteIpRequest}
11121
11201
  */
11122
11202
  deleteIp: (request: Readonly<DeleteIpRequest>) => Promise<void>;
11123
11203
  protected pageOfListPrivateNICs: (request: Readonly<ListPrivateNICsRequest>) => Promise<ListPrivateNICsResponse>;
11124
11204
  /**
11125
- * List all private NICs. List all private NICs of a given server.
11205
+ * List all private NICs. List all private NICs of a specified Instance.
11126
11206
  *
11127
11207
  * @param request - The request {@link ListPrivateNICsRequest}
11128
11208
  * @returns A Promise of ListPrivateNICsResponse
@@ -11132,7 +11212,7 @@ declare class API$f extends API$q {
11132
11212
  [Symbol.asyncIterator]: () => AsyncGenerator<PrivateNIC[], void, void>;
11133
11213
  };
11134
11214
  /**
11135
- * Create a private NIC connecting a server to a private network.
11215
+ * Create a private NIC connecting an Instance to a Private Network.
11136
11216
  *
11137
11217
  * @param request - The request {@link CreatePrivateNICRequest}
11138
11218
  * @returns A Promise of CreatePrivateNICResponse
@@ -11146,8 +11226,8 @@ declare class API$f extends API$q {
11146
11226
  */
11147
11227
  getPrivateNIC: (request: Readonly<GetPrivateNICRequest>) => Promise<GetPrivateNICResponse>;
11148
11228
  /**
11149
- * Update a private NIC. Update one or more parameter/s to a given private
11150
- * NIC.
11229
+ * Update a private NIC. Update one or more parameter(s) of a specified
11230
+ * private NIC.
11151
11231
  *
11152
11232
  * @param request - The request {@link UpdatePrivateNICRequest}
11153
11233
  * @returns A Promise of PrivateNIC
@@ -11172,7 +11252,7 @@ declare class API$f extends API$q {
11172
11252
  [Symbol.asyncIterator]: () => AsyncGenerator<Bootscript[], void, void>;
11173
11253
  };
11174
11254
  /**
11175
- * Get bootscripts. Get details of a bootscript with the given ID.
11255
+ * Get bootscripts. Get details of a bootscript with the specified ID.
11176
11256
  *
11177
11257
  * @deprecated
11178
11258
  * @param request - The request {@link GetBootscriptRequest}
@@ -13239,11 +13319,8 @@ interface Cluster$1 {
13239
13319
  /** List of enabled admission plugins. */
13240
13320
  admissionPlugins: string[];
13241
13321
  /**
13242
- * ALPHA - The OpenID Connect configuration of the cluster. This feature is in
13243
- * ALPHA state, it may be deleted or modified. This configuration is the
13244
- * [OpenID Connect
13245
- * configuration](https://kubernetes.io/docs/reference/access-authn-authz/authentication/#openid-connect-tokens)
13246
- * of the Kubernetes API server.
13322
+ * OpenID Connect configuration of the cluster. This configuration enables to
13323
+ * update the OpenID Connect configuration of the Kubernetes API server.
13247
13324
  */
13248
13325
  openIdConnectConfig?: ClusterOpenIDConnectConfig;
13249
13326
  /**
@@ -13861,11 +13938,8 @@ type CreateClusterRequest$2 = {
13861
13938
  /** List of admission plugins to enable. */
13862
13939
  admissionPlugins?: string[];
13863
13940
  /**
13864
- * ALPHA - OpenID Connect configuration of the cluster. This feature is in
13865
- * ALPHA state, it may be deleted or modified. This configuration enables to
13866
- * set the [OpenID Connect
13867
- * configuration](https://kubernetes.io/docs/reference/access-authn-authz/authentication/#openid-connect-tokens)
13868
- * of the Kubernetes API server.
13941
+ * OpenID Connect configuration of the cluster. This configuration enables to
13942
+ * update the OpenID Connect configuration of the Kubernetes API server.
13869
13943
  */
13870
13944
  openIdConnectConfig?: CreateClusterRequestOpenIDConnectConfig$1;
13871
13945
  /**
@@ -14930,6 +15004,10 @@ interface Backend {
14930
15004
  sslBridging?: boolean;
14931
15005
  /** Defines whether the server certificate verification should be ignored. */
14932
15006
  ignoreSslServerVerify?: boolean;
15007
+ /** Whether to use another backend server on each attempt. */
15008
+ redispatchAttemptCount?: number;
15009
+ /** Number of retries when a backend server connection failed. */
15010
+ maxRetries?: number;
14933
15011
  }
14934
15012
  /** Backend server stats. */
14935
15013
  interface BackendServerStats {
@@ -15027,21 +15105,48 @@ interface Frontend {
15027
15105
  }
15028
15106
  /** Health check. */
15029
15107
  interface HealthCheck {
15108
+ /** Port to use for the backend server health check. */
15109
+ port: number;
15110
+ /** Time to wait between two consecutive health checks. */
15111
+ checkDelay?: string;
15112
+ /** Maximum time a backend server has to reply to the health check. */
15113
+ checkTimeout?: string;
15114
+ /**
15115
+ * Number of consecutive unsuccessful health checks after which the server
15116
+ * will be considered dead.
15117
+ */
15118
+ checkMaxRetries: number;
15119
+ /**
15120
+ * Object to configure a basic TCP health check.
15121
+ *
15122
+ * One-of ('config'): at most one of 'tcpConfig', 'mysqlConfig',
15123
+ * 'pgsqlConfig', 'ldapConfig', 'redisConfig', 'httpConfig', 'httpsConfig'
15124
+ * could be set.
15125
+ */
15126
+ tcpConfig?: HealthCheckTcpConfig;
15030
15127
  /**
15031
15128
  * Object to configure a MySQL health check. The check requires MySQL >=3.22,
15032
15129
  * for older versions, use a TCP health check.
15033
15130
  *
15034
- * One-of ('config'): at most one of 'mysqlConfig', 'ldapConfig',
15035
- * 'redisConfig', 'tcpConfig', 'pgsqlConfig', 'httpConfig', 'httpsConfig'
15131
+ * One-of ('config'): at most one of 'tcpConfig', 'mysqlConfig',
15132
+ * 'pgsqlConfig', 'ldapConfig', 'redisConfig', 'httpConfig', 'httpsConfig'
15036
15133
  * could be set.
15037
15134
  */
15038
15135
  mysqlConfig?: HealthCheckMysqlConfig;
15136
+ /**
15137
+ * Object to configure a PostgreSQL health check.
15138
+ *
15139
+ * One-of ('config'): at most one of 'tcpConfig', 'mysqlConfig',
15140
+ * 'pgsqlConfig', 'ldapConfig', 'redisConfig', 'httpConfig', 'httpsConfig'
15141
+ * could be set.
15142
+ */
15143
+ pgsqlConfig?: HealthCheckPgsqlConfig;
15039
15144
  /**
15040
15145
  * Object to configure an LDAP health check. The response is analyzed to find
15041
15146
  * the LDAPv3 response message.
15042
15147
  *
15043
- * One-of ('config'): at most one of 'mysqlConfig', 'ldapConfig',
15044
- * 'redisConfig', 'tcpConfig', 'pgsqlConfig', 'httpConfig', 'httpsConfig'
15148
+ * One-of ('config'): at most one of 'tcpConfig', 'mysqlConfig',
15149
+ * 'pgsqlConfig', 'ldapConfig', 'redisConfig', 'httpConfig', 'httpsConfig'
15045
15150
  * could be set.
15046
15151
  */
15047
15152
  ldapConfig?: HealthCheckLdapConfig;
@@ -15049,56 +15154,34 @@ interface HealthCheck {
15049
15154
  * Object to configure a Redis health check. The response is analyzed to find
15050
15155
  * the +PONG response message.
15051
15156
  *
15052
- * One-of ('config'): at most one of 'mysqlConfig', 'ldapConfig',
15053
- * 'redisConfig', 'tcpConfig', 'pgsqlConfig', 'httpConfig', 'httpsConfig'
15157
+ * One-of ('config'): at most one of 'tcpConfig', 'mysqlConfig',
15158
+ * 'pgsqlConfig', 'ldapConfig', 'redisConfig', 'httpConfig', 'httpsConfig'
15054
15159
  * could be set.
15055
15160
  */
15056
15161
  redisConfig?: HealthCheckRedisConfig;
15057
- /**
15058
- * Number of consecutive unsuccessful health checks after which the server
15059
- * will be considered dead.
15060
- */
15061
- checkMaxRetries: number;
15062
- /**
15063
- * Object to configure a basic TCP health check.
15064
- *
15065
- * One-of ('config'): at most one of 'mysqlConfig', 'ldapConfig',
15066
- * 'redisConfig', 'tcpConfig', 'pgsqlConfig', 'httpConfig', 'httpsConfig'
15067
- * could be set.
15068
- */
15069
- tcpConfig?: HealthCheckTcpConfig;
15070
- /**
15071
- * Object to configure a PostgreSQL health check.
15072
- *
15073
- * One-of ('config'): at most one of 'mysqlConfig', 'ldapConfig',
15074
- * 'redisConfig', 'tcpConfig', 'pgsqlConfig', 'httpConfig', 'httpsConfig'
15075
- * could be set.
15076
- */
15077
- pgsqlConfig?: HealthCheckPgsqlConfig;
15078
15162
  /**
15079
15163
  * Object to configure an HTTP health check.
15080
15164
  *
15081
- * One-of ('config'): at most one of 'mysqlConfig', 'ldapConfig',
15082
- * 'redisConfig', 'tcpConfig', 'pgsqlConfig', 'httpConfig', 'httpsConfig'
15165
+ * One-of ('config'): at most one of 'tcpConfig', 'mysqlConfig',
15166
+ * 'pgsqlConfig', 'ldapConfig', 'redisConfig', 'httpConfig', 'httpsConfig'
15083
15167
  * could be set.
15084
15168
  */
15085
15169
  httpConfig?: HealthCheckHttpConfig;
15086
15170
  /**
15087
15171
  * Object to configure an HTTPS health check.
15088
15172
  *
15089
- * One-of ('config'): at most one of 'mysqlConfig', 'ldapConfig',
15090
- * 'redisConfig', 'tcpConfig', 'pgsqlConfig', 'httpConfig', 'httpsConfig'
15173
+ * One-of ('config'): at most one of 'tcpConfig', 'mysqlConfig',
15174
+ * 'pgsqlConfig', 'ldapConfig', 'redisConfig', 'httpConfig', 'httpsConfig'
15091
15175
  * could be set.
15092
15176
  */
15093
15177
  httpsConfig?: HealthCheckHttpsConfig;
15094
- /** Port to use for the backend server health check. */
15095
- port: number;
15096
- /** Maximum time a backend server has to reply to the health check. */
15097
- checkTimeout?: string;
15098
- /** Time to wait between two consecutive health checks. */
15099
- checkDelay?: string;
15100
15178
  /** Defines whether proxy protocol should be activated for the health check. */
15101
15179
  checkSendProxy: boolean;
15180
+ /**
15181
+ * Time to wait between two consecutive health checks when a backend server is
15182
+ * in a transient state (going UP or DOWN).
15183
+ */
15184
+ transientCheckDelay?: string;
15102
15185
  }
15103
15186
  /** Health check. http config. */
15104
15187
  interface HealthCheckHttpConfig {
@@ -15155,10 +15238,14 @@ interface HealthCheckHttpsConfig {
15155
15238
  }
15156
15239
  interface HealthCheckLdapConfig {
15157
15240
  }
15241
+ /** Health check. mysql config. */
15158
15242
  interface HealthCheckMysqlConfig {
15243
+ /** MySQL user to use for the health check. */
15159
15244
  user: string;
15160
15245
  }
15246
+ /** Health check. pgsql config. */
15161
15247
  interface HealthCheckPgsqlConfig {
15248
+ /** PostgreSQL user to use for the health check. */
15162
15249
  user: string;
15163
15250
  }
15164
15251
  interface HealthCheckRedisConfig {
@@ -15252,12 +15339,17 @@ interface LbStats {
15252
15339
  /** List of objects containing Load Balancer statistics. */
15253
15340
  backendServersStats: BackendServerStats[];
15254
15341
  }
15342
+ /** Lb type. */
15255
15343
  interface LbType {
15344
+ /** Load Balancer commercial offer type name. */
15256
15345
  name: string;
15346
+ /** Current stock status for a given Load Balancer type. */
15257
15347
  stockStatus: LbTypeStock;
15348
+ /** Load Balancer commercial offer type description. */
15258
15349
  description: string;
15259
- /** @deprecated */
15350
+ /** @deprecated The region the Load Balancer stock is in. */
15260
15351
  region?: Region;
15352
+ /** The zone the Load Balancer stock is in. */
15261
15353
  zone: Zone;
15262
15354
  }
15263
15355
  /** List acl response. */
@@ -15376,7 +15468,9 @@ interface PrivateNetworkDHCPConfig {
15376
15468
  }
15377
15469
  interface PrivateNetworkIpamConfig {
15378
15470
  }
15471
+ /** Private network. static config. */
15379
15472
  interface PrivateNetworkStaticConfig {
15473
+ /** Array of a local IP address for the Load Balancer on this Private Network. */
15380
15474
  ipAddress: string[];
15381
15475
  }
15382
15476
  /** Route. */
@@ -15736,24 +15830,27 @@ type CreateBackendRequest = {
15736
15830
  /** Action to take when a backend server is marked as down. */
15737
15831
  onMarkedDownAction?: OnMarkedDownAction;
15738
15832
  /**
15739
- * PROXY protocol to use between the Load Balancer and backend servers. Allows
15740
- * the backend servers to be informed of the client's real IP address. PROXY
15833
+ * Protocol to use between the Load Balancer and backend servers. Allows the
15834
+ * backend servers to be informed of the client's real IP address. The PROXY
15741
15835
  * protocol must be supported by the backend servers' software.
15742
15836
  */
15743
15837
  proxyProtocol?: ProxyProtocol;
15744
15838
  /**
15745
15839
  * Scaleway S3 bucket website to be served as failover if all backend servers
15746
- * are down, e.g. failover-website.s3-website.fr-par.scw.cloud. Do not include
15747
- * the scheme (eg https://).
15840
+ * are down, e.g. failover-website.s3-website.fr-par.scw.cloud.
15748
15841
  */
15749
15842
  failoverHost?: string;
15750
15843
  /**
15751
- * Defines whether to enable SSL between the Load Balancer and backend
15752
- * servers.
15844
+ * Defines whether to enable SSL bridging between the Load Balancer and
15845
+ * backend servers.
15753
15846
  */
15754
15847
  sslBridging?: boolean;
15755
15848
  /** Defines whether the server certificate verification should be ignored. */
15756
15849
  ignoreSslServerVerify?: boolean;
15850
+ /** Whether to use another backend server on each attempt. */
15851
+ redispatchAttemptCount?: number;
15852
+ /** Number of retries when a backend server connection failed. */
15853
+ maxRetries?: number;
15757
15854
  };
15758
15855
  type GetBackendRequest = {
15759
15856
  /**
@@ -15807,18 +15904,17 @@ type UpdateBackendRequest = {
15807
15904
  * (takes precedence over client and server timeout).
15808
15905
  */
15809
15906
  timeoutTunnel?: string;
15810
- /** Action to take when a backend server is marked down. */
15907
+ /** Action to take when a backend server is marked as down. */
15811
15908
  onMarkedDownAction?: OnMarkedDownAction;
15812
15909
  /**
15813
- * PROXY protocol to use between the Load Balancer and backend servers. Allows
15814
- * the backend servers to be informed of the client's real IP address. PROXY
15910
+ * Protocol to use between the Load Balancer and backend servers. Allows the
15911
+ * backend servers to be informed of the client's real IP address. The PROXY
15815
15912
  * protocol must be supported by the backend servers' software.
15816
15913
  */
15817
15914
  proxyProtocol?: ProxyProtocol;
15818
15915
  /**
15819
15916
  * Scaleway S3 bucket website to be served as failover if all backend servers
15820
- * are down, e.g. failover-website.s3-website.fr-par.scw.cloud. Do not include
15821
- * the scheme (eg https://).
15917
+ * are down, e.g. failover-website.s3-website.fr-par.scw.cloud.
15822
15918
  */
15823
15919
  failoverHost?: string;
15824
15920
  /**
@@ -15828,6 +15924,10 @@ type UpdateBackendRequest = {
15828
15924
  sslBridging?: boolean;
15829
15925
  /** Defines whether the server certificate verification should be ignored. */
15830
15926
  ignoreSslServerVerify?: boolean;
15927
+ /** Whether to use another backend server on each attempt. */
15928
+ redispatchAttemptCount?: number;
15929
+ /** Number of retries when a backend server connection failed. */
15930
+ maxRetries?: number;
15831
15931
  };
15832
15932
  type DeleteBackendRequest = {
15833
15933
  /**
@@ -15889,68 +15989,76 @@ type UpdateHealthCheckRequest = {
15889
15989
  /** Maximum time a backend server has to reply to the health check. */
15890
15990
  checkTimeout: string;
15891
15991
  /**
15892
- * Number of consecutive unsuccessful health checks, after which the server
15992
+ * Number of consecutive unsuccessful health checks after which the server
15893
15993
  * will be considered dead.
15894
15994
  */
15895
15995
  checkMaxRetries: number;
15996
+ /** Defines whether proxy protocol should be activated for the health check. */
15997
+ checkSendProxy: boolean;
15896
15998
  /**
15897
- * The check requires MySQL >=3.22, for older version, please use TCP check.
15999
+ * Object to configure a basic TCP health check.
15898
16000
  *
15899
- * One-of ('config'): at most one of 'mysqlConfig', 'ldapConfig',
15900
- * 'redisConfig', 'pgsqlConfig', 'tcpConfig', 'httpConfig', 'httpsConfig'
16001
+ * One-of ('config'): at most one of 'tcpConfig', 'mysqlConfig',
16002
+ * 'pgsqlConfig', 'ldapConfig', 'redisConfig', 'httpConfig', 'httpsConfig'
15901
16003
  * could be set.
15902
16004
  */
15903
- mysqlConfig?: HealthCheckMysqlConfig;
16005
+ tcpConfig?: HealthCheckTcpConfig;
15904
16006
  /**
15905
- * The response is analyzed to find an LDAPv3 response message.
16007
+ * Object to configure a MySQL health check. The check requires MySQL >=3.22,
16008
+ * for older versions, use a TCP health check.
15906
16009
  *
15907
- * One-of ('config'): at most one of 'mysqlConfig', 'ldapConfig',
15908
- * 'redisConfig', 'pgsqlConfig', 'tcpConfig', 'httpConfig', 'httpsConfig'
16010
+ * One-of ('config'): at most one of 'tcpConfig', 'mysqlConfig',
16011
+ * 'pgsqlConfig', 'ldapConfig', 'redisConfig', 'httpConfig', 'httpsConfig'
15909
16012
  * could be set.
15910
16013
  */
15911
- ldapConfig?: HealthCheckLdapConfig;
16014
+ mysqlConfig?: HealthCheckMysqlConfig;
15912
16015
  /**
15913
- * The response is analyzed to find the +PONG response message.
16016
+ * Object to configure a PostgreSQL health check.
15914
16017
  *
15915
- * One-of ('config'): at most one of 'mysqlConfig', 'ldapConfig',
15916
- * 'redisConfig', 'pgsqlConfig', 'tcpConfig', 'httpConfig', 'httpsConfig'
16018
+ * One-of ('config'): at most one of 'tcpConfig', 'mysqlConfig',
16019
+ * 'pgsqlConfig', 'ldapConfig', 'redisConfig', 'httpConfig', 'httpsConfig'
15917
16020
  * could be set.
15918
16021
  */
15919
- redisConfig?: HealthCheckRedisConfig;
16022
+ pgsqlConfig?: HealthCheckPgsqlConfig;
15920
16023
  /**
15921
- * PostgreSQL health check.
16024
+ * Object to configure an LDAP health check. The response is analyzed to find
16025
+ * the LDAPv3 response message.
15922
16026
  *
15923
- * One-of ('config'): at most one of 'mysqlConfig', 'ldapConfig',
15924
- * 'redisConfig', 'pgsqlConfig', 'tcpConfig', 'httpConfig', 'httpsConfig'
16027
+ * One-of ('config'): at most one of 'tcpConfig', 'mysqlConfig',
16028
+ * 'pgsqlConfig', 'ldapConfig', 'redisConfig', 'httpConfig', 'httpsConfig'
15925
16029
  * could be set.
15926
16030
  */
15927
- pgsqlConfig?: HealthCheckPgsqlConfig;
16031
+ ldapConfig?: HealthCheckLdapConfig;
15928
16032
  /**
15929
- * Basic TCP health check.
16033
+ * Object to configure a Redis health check. The response is analyzed to find
16034
+ * the +PONG response message.
15930
16035
  *
15931
- * One-of ('config'): at most one of 'mysqlConfig', 'ldapConfig',
15932
- * 'redisConfig', 'pgsqlConfig', 'tcpConfig', 'httpConfig', 'httpsConfig'
16036
+ * One-of ('config'): at most one of 'tcpConfig', 'mysqlConfig',
16037
+ * 'pgsqlConfig', 'ldapConfig', 'redisConfig', 'httpConfig', 'httpsConfig'
15933
16038
  * could be set.
15934
16039
  */
15935
- tcpConfig?: HealthCheckTcpConfig;
16040
+ redisConfig?: HealthCheckRedisConfig;
15936
16041
  /**
15937
- * HTTP health check.
16042
+ * Object to configure an HTTP health check.
15938
16043
  *
15939
- * One-of ('config'): at most one of 'mysqlConfig', 'ldapConfig',
15940
- * 'redisConfig', 'pgsqlConfig', 'tcpConfig', 'httpConfig', 'httpsConfig'
16044
+ * One-of ('config'): at most one of 'tcpConfig', 'mysqlConfig',
16045
+ * 'pgsqlConfig', 'ldapConfig', 'redisConfig', 'httpConfig', 'httpsConfig'
15941
16046
  * could be set.
15942
16047
  */
15943
16048
  httpConfig?: HealthCheckHttpConfig;
15944
16049
  /**
15945
- * HTTPS health check.
16050
+ * Object to configure an HTTPS health check.
15946
16051
  *
15947
- * One-of ('config'): at most one of 'mysqlConfig', 'ldapConfig',
15948
- * 'redisConfig', 'pgsqlConfig', 'tcpConfig', 'httpConfig', 'httpsConfig'
16052
+ * One-of ('config'): at most one of 'tcpConfig', 'mysqlConfig',
16053
+ * 'pgsqlConfig', 'ldapConfig', 'redisConfig', 'httpConfig', 'httpsConfig'
15949
16054
  * could be set.
15950
16055
  */
15951
16056
  httpsConfig?: HealthCheckHttpsConfig;
15952
- /** Defines whether proxy protocol should be activated for the health check. */
15953
- checkSendProxy: boolean;
16057
+ /**
16058
+ * Time to wait between two consecutive health checks when a backend server is
16059
+ * in a transient state (going UP or DOWN).
16060
+ */
16061
+ transientCheckDelay?: string;
15954
16062
  };
15955
16063
  type ListFrontendsRequest = {
15956
16064
  /**
@@ -16045,6 +16153,7 @@ type ListRoutesRequest = {
16045
16153
  pageSize?: number;
16046
16154
  /** The page number to return, from the paginated results. */
16047
16155
  page?: number;
16156
+ /** Frontend ID to filter for, only Routes from this Frontend will be returned. */
16048
16157
  frontendId?: string;
16049
16158
  };
16050
16159
  type CreateRouteRequest = {
@@ -16714,24 +16823,27 @@ type ZonedApiCreateBackendRequest = {
16714
16823
  /** Action to take when a backend server is marked as down. */
16715
16824
  onMarkedDownAction?: OnMarkedDownAction;
16716
16825
  /**
16717
- * PROXY protocol to use between the Load Balancer and backend servers. Allows
16718
- * the backend servers to be informed of the client's real IP address. PROXY
16826
+ * Protocol to use between the Load Balancer and backend servers. Allows the
16827
+ * backend servers to be informed of the client's real IP address. The PROXY
16719
16828
  * protocol must be supported by the backend servers' software.
16720
16829
  */
16721
16830
  proxyProtocol?: ProxyProtocol;
16722
16831
  /**
16723
16832
  * Scaleway S3 bucket website to be served as failover if all backend servers
16724
- * are down, e.g. failover-website.s3-website.fr-par.scw.cloud. Do not include
16725
- * the scheme (eg https://).
16833
+ * are down, e.g. failover-website.s3-website.fr-par.scw.cloud.
16726
16834
  */
16727
16835
  failoverHost?: string;
16728
16836
  /**
16729
- * Defines whether to enable SSL between the Load Balancer and backend
16730
- * servers.
16837
+ * Defines whether to enable SSL bridging between the Load Balancer and
16838
+ * backend servers.
16731
16839
  */
16732
16840
  sslBridging?: boolean;
16733
16841
  /** Defines whether the server certificate verification should be ignored. */
16734
16842
  ignoreSslServerVerify?: boolean;
16843
+ /** Whether to use another backend server on each attempt. */
16844
+ redispatchAttemptCount?: number;
16845
+ /** Number of retries when a backend server connection failed. */
16846
+ maxRetries?: number;
16735
16847
  };
16736
16848
  type ZonedApiGetBackendRequest = {
16737
16849
  /** Zone to target. If none is passed will use default zone from the config. */
@@ -16779,18 +16891,17 @@ type ZonedApiUpdateBackendRequest = {
16779
16891
  * (takes precedence over client and server timeout).
16780
16892
  */
16781
16893
  timeoutTunnel?: string;
16782
- /** Action to take when a backend server is marked down. */
16894
+ /** Action to take when a backend server is marked as down. */
16783
16895
  onMarkedDownAction?: OnMarkedDownAction;
16784
16896
  /**
16785
- * PROXY protocol to use between the Load Balancer and backend servers. Allows
16786
- * the backend servers to be informed of the client's real IP address. PROXY
16897
+ * Protocol to use between the Load Balancer and backend servers. Allows the
16898
+ * backend servers to be informed of the client's real IP address. The PROXY
16787
16899
  * protocol must be supported by the backend servers' software.
16788
16900
  */
16789
16901
  proxyProtocol?: ProxyProtocol;
16790
16902
  /**
16791
16903
  * Scaleway S3 bucket website to be served as failover if all backend servers
16792
- * are down, e.g. failover-website.s3-website.fr-par.scw.cloud. Do not include
16793
- * the scheme (eg https://).
16904
+ * are down, e.g. failover-website.s3-website.fr-par.scw.cloud.
16794
16905
  */
16795
16906
  failoverHost?: string;
16796
16907
  /**
@@ -16800,6 +16911,10 @@ type ZonedApiUpdateBackendRequest = {
16800
16911
  sslBridging?: boolean;
16801
16912
  /** Defines whether the server certificate verification should be ignored. */
16802
16913
  ignoreSslServerVerify?: boolean;
16914
+ /** Whether to use another backend server on each attempt. */
16915
+ redispatchAttemptCount?: number;
16916
+ /** Number of retries when a backend server connection failed. */
16917
+ maxRetries?: number;
16803
16918
  };
16804
16919
  type ZonedApiDeleteBackendRequest = {
16805
16920
  /** Zone to target. If none is passed will use default zone from the config. */
@@ -16846,68 +16961,76 @@ type ZonedApiUpdateHealthCheckRequest = {
16846
16961
  /** Maximum time a backend server has to reply to the health check. */
16847
16962
  checkTimeout: string;
16848
16963
  /**
16849
- * Number of consecutive unsuccessful health checks, after which the server
16964
+ * Number of consecutive unsuccessful health checks after which the server
16850
16965
  * will be considered dead.
16851
16966
  */
16852
16967
  checkMaxRetries: number;
16968
+ /** Defines whether proxy protocol should be activated for the health check. */
16969
+ checkSendProxy: boolean;
16853
16970
  /**
16854
- * The check requires MySQL >=3.22, for older version, please use TCP check.
16971
+ * Object to configure a basic TCP health check.
16855
16972
  *
16856
- * One-of ('config'): at most one of 'mysqlConfig', 'ldapConfig',
16857
- * 'redisConfig', 'pgsqlConfig', 'tcpConfig', 'httpConfig', 'httpsConfig'
16973
+ * One-of ('config'): at most one of 'tcpConfig', 'mysqlConfig',
16974
+ * 'pgsqlConfig', 'ldapConfig', 'redisConfig', 'httpConfig', 'httpsConfig'
16858
16975
  * could be set.
16859
16976
  */
16860
- mysqlConfig?: HealthCheckMysqlConfig;
16977
+ tcpConfig?: HealthCheckTcpConfig;
16861
16978
  /**
16862
- * The response is analyzed to find an LDAPv3 response message.
16979
+ * Object to configure a MySQL health check. The check requires MySQL >=3.22,
16980
+ * for older versions, use a TCP health check.
16863
16981
  *
16864
- * One-of ('config'): at most one of 'mysqlConfig', 'ldapConfig',
16865
- * 'redisConfig', 'pgsqlConfig', 'tcpConfig', 'httpConfig', 'httpsConfig'
16982
+ * One-of ('config'): at most one of 'tcpConfig', 'mysqlConfig',
16983
+ * 'pgsqlConfig', 'ldapConfig', 'redisConfig', 'httpConfig', 'httpsConfig'
16866
16984
  * could be set.
16867
16985
  */
16868
- ldapConfig?: HealthCheckLdapConfig;
16986
+ mysqlConfig?: HealthCheckMysqlConfig;
16869
16987
  /**
16870
- * The response is analyzed to find the +PONG response message.
16988
+ * Object to configure a PostgreSQL health check.
16871
16989
  *
16872
- * One-of ('config'): at most one of 'mysqlConfig', 'ldapConfig',
16873
- * 'redisConfig', 'pgsqlConfig', 'tcpConfig', 'httpConfig', 'httpsConfig'
16990
+ * One-of ('config'): at most one of 'tcpConfig', 'mysqlConfig',
16991
+ * 'pgsqlConfig', 'ldapConfig', 'redisConfig', 'httpConfig', 'httpsConfig'
16874
16992
  * could be set.
16875
16993
  */
16876
- redisConfig?: HealthCheckRedisConfig;
16994
+ pgsqlConfig?: HealthCheckPgsqlConfig;
16877
16995
  /**
16878
- * PostgreSQL health check.
16996
+ * Object to configure an LDAP health check. The response is analyzed to find
16997
+ * the LDAPv3 response message.
16879
16998
  *
16880
- * One-of ('config'): at most one of 'mysqlConfig', 'ldapConfig',
16881
- * 'redisConfig', 'pgsqlConfig', 'tcpConfig', 'httpConfig', 'httpsConfig'
16999
+ * One-of ('config'): at most one of 'tcpConfig', 'mysqlConfig',
17000
+ * 'pgsqlConfig', 'ldapConfig', 'redisConfig', 'httpConfig', 'httpsConfig'
16882
17001
  * could be set.
16883
17002
  */
16884
- pgsqlConfig?: HealthCheckPgsqlConfig;
17003
+ ldapConfig?: HealthCheckLdapConfig;
16885
17004
  /**
16886
- * Basic TCP health check.
17005
+ * Object to configure a Redis health check. The response is analyzed to find
17006
+ * the +PONG response message.
16887
17007
  *
16888
- * One-of ('config'): at most one of 'mysqlConfig', 'ldapConfig',
16889
- * 'redisConfig', 'pgsqlConfig', 'tcpConfig', 'httpConfig', 'httpsConfig'
17008
+ * One-of ('config'): at most one of 'tcpConfig', 'mysqlConfig',
17009
+ * 'pgsqlConfig', 'ldapConfig', 'redisConfig', 'httpConfig', 'httpsConfig'
16890
17010
  * could be set.
16891
17011
  */
16892
- tcpConfig?: HealthCheckTcpConfig;
17012
+ redisConfig?: HealthCheckRedisConfig;
16893
17013
  /**
16894
- * HTTP health check.
17014
+ * Object to configure an HTTP health check.
16895
17015
  *
16896
- * One-of ('config'): at most one of 'mysqlConfig', 'ldapConfig',
16897
- * 'redisConfig', 'pgsqlConfig', 'tcpConfig', 'httpConfig', 'httpsConfig'
17016
+ * One-of ('config'): at most one of 'tcpConfig', 'mysqlConfig',
17017
+ * 'pgsqlConfig', 'ldapConfig', 'redisConfig', 'httpConfig', 'httpsConfig'
16898
17018
  * could be set.
16899
17019
  */
16900
17020
  httpConfig?: HealthCheckHttpConfig;
16901
17021
  /**
16902
- * HTTPS health check.
17022
+ * Object to configure an HTTPS health check.
16903
17023
  *
16904
- * One-of ('config'): at most one of 'mysqlConfig', 'ldapConfig',
16905
- * 'redisConfig', 'pgsqlConfig', 'tcpConfig', 'httpConfig', 'httpsConfig'
17024
+ * One-of ('config'): at most one of 'tcpConfig', 'mysqlConfig',
17025
+ * 'pgsqlConfig', 'ldapConfig', 'redisConfig', 'httpConfig', 'httpsConfig'
16906
17026
  * could be set.
16907
17027
  */
16908
17028
  httpsConfig?: HealthCheckHttpsConfig;
16909
- /** Defines whether proxy protocol should be activated for the health check. */
16910
- checkSendProxy: boolean;
17029
+ /**
17030
+ * Time to wait between two consecutive health checks when a backend server is
17031
+ * in a transient state (going UP or DOWN).
17032
+ */
17033
+ transientCheckDelay?: string;
16911
17034
  };
16912
17035
  type ZonedApiListFrontendsRequest = {
16913
17036
  /** Zone to target. If none is passed will use default zone from the config. */
@@ -16984,6 +17107,7 @@ type ZonedApiListRoutesRequest = {
16984
17107
  pageSize?: number;
16985
17108
  /** The page number to return, from the paginated results. */
16986
17109
  page?: number;
17110
+ /** Frontend ID to filter for, only Routes from this Frontend will be returned. */
16987
17111
  frontendId?: string;
16988
17112
  };
16989
17113
  type ZonedApiCreateRouteRequest = {
@@ -21937,6 +22061,13 @@ interface EndpointSpecPrivateNetworkSpec {
21937
22061
  * IPv4 per node.
21938
22062
  */
21939
22063
  serviceIps: string[];
22064
+ /**
22065
+ * Automated configuration of your Private Network endpoint with Scaleway IPAM
22066
+ * service.
22067
+ */
22068
+ ipamConfig?: EndpointSpecPrivateNetworkSpecIpamConfig;
22069
+ }
22070
+ interface EndpointSpecPrivateNetworkSpecIpamConfig {
21940
22071
  }
21941
22072
  /** Endpoint spec. public network spec. */
21942
22073
  interface EndpointSpecPublicNetworkSpec {
@@ -22522,6 +22653,7 @@ type index_gen$7_DeleteEndpointRequest = DeleteEndpointRequest;
22522
22653
  type index_gen$7_Endpoint = Endpoint;
22523
22654
  type index_gen$7_EndpointSpec = EndpointSpec;
22524
22655
  type index_gen$7_EndpointSpecPrivateNetworkSpec = EndpointSpecPrivateNetworkSpec;
22656
+ type index_gen$7_EndpointSpecPrivateNetworkSpecIpamConfig = EndpointSpecPrivateNetworkSpecIpamConfig;
22525
22657
  type index_gen$7_EndpointSpecPublicNetworkSpec = EndpointSpecPublicNetworkSpec;
22526
22658
  type index_gen$7_GetAclRuleRequest = GetAclRuleRequest;
22527
22659
  type index_gen$7_GetClusterCertificateRequest = GetClusterCertificateRequest;
@@ -22574,6 +22706,7 @@ declare namespace index_gen$7 {
22574
22706
  index_gen$7_Endpoint as Endpoint,
22575
22707
  index_gen$7_EndpointSpec as EndpointSpec,
22576
22708
  index_gen$7_EndpointSpecPrivateNetworkSpec as EndpointSpecPrivateNetworkSpec,
22709
+ index_gen$7_EndpointSpecPrivateNetworkSpecIpamConfig as EndpointSpecPrivateNetworkSpecIpamConfig,
22577
22710
  index_gen$7_EndpointSpecPublicNetworkSpec as EndpointSpecPublicNetworkSpec,
22578
22711
  index_gen$7_GetAclRuleRequest as GetAclRuleRequest,
22579
22712
  index_gen$7_GetClusterCertificateRequest as GetClusterCertificateRequest,
@@ -23140,6 +23273,19 @@ interface ListSecretsResponse {
23140
23273
  /** Single page of secrets matching the requested criteria. */
23141
23274
  secrets: Secret[];
23142
23275
  }
23276
+ /** Password generation params. */
23277
+ interface PasswordGenerationParams {
23278
+ /** Length of the password to generate (between 1 and 1024). */
23279
+ length: number;
23280
+ /** Do not include lower case letters by default in the alphabet. */
23281
+ noLowercaseLetters: boolean;
23282
+ /** Do not include upper case letters by default in the alphabet. */
23283
+ noUppercaseLetters: boolean;
23284
+ /** Do not include digits by default in the alphabet. */
23285
+ noDigits: boolean;
23286
+ /** Additional ascii characters to be included in the alphabet. */
23287
+ additionalChars: string;
23288
+ }
23143
23289
  /** Secret. */
23144
23290
  interface Secret {
23145
23291
  /** ID of the secret. */
@@ -23276,6 +23422,21 @@ type CreateSecretVersionRequest = {
23276
23422
  data: string;
23277
23423
  /** Description of the version. */
23278
23424
  description?: string;
23425
+ /**
23426
+ * Disable the previous secret version. If there is no previous version or if
23427
+ * the previous version was already disabled, does nothing.
23428
+ */
23429
+ disablePrevious: boolean;
23430
+ /**
23431
+ * Options to generate a password. If specified, a random password will be
23432
+ * generated. The data field must be empty. By default, the generator will use
23433
+ * upper and lower case letters, and digits. This behavior can be tuned using
23434
+ * the generation params.
23435
+ *
23436
+ * One-of ('PasswordGeneration'): at most one of 'passwordGeneration' could be
23437
+ * set.
23438
+ */
23439
+ passwordGeneration?: PasswordGenerationParams;
23279
23440
  };
23280
23441
  type GetSecretVersionRequest = {
23281
23442
  /**
@@ -23602,6 +23763,7 @@ type index_gen$5_ListSecretVersionsResponse = ListSecretVersionsResponse;
23602
23763
  type index_gen$5_ListSecretsRequest = ListSecretsRequest;
23603
23764
  type index_gen$5_ListSecretsRequestOrderBy = ListSecretsRequestOrderBy;
23604
23765
  type index_gen$5_ListSecretsResponse = ListSecretsResponse;
23766
+ type index_gen$5_PasswordGenerationParams = PasswordGenerationParams;
23605
23767
  type index_gen$5_Secret = Secret;
23606
23768
  type index_gen$5_SecretStatus = SecretStatus;
23607
23769
  type index_gen$5_SecretVersion = SecretVersion;
@@ -23630,6 +23792,7 @@ declare namespace index_gen$5 {
23630
23792
  index_gen$5_ListSecretsRequest as ListSecretsRequest,
23631
23793
  index_gen$5_ListSecretsRequestOrderBy as ListSecretsRequestOrderBy,
23632
23794
  index_gen$5_ListSecretsResponse as ListSecretsResponse,
23795
+ index_gen$5_PasswordGenerationParams as PasswordGenerationParams,
23633
23796
  index_gen$5_Secret as Secret,
23634
23797
  index_gen$5_SecretStatus as SecretStatus,
23635
23798
  index_gen$5_SecretVersion as SecretVersion,
@@ -24396,6 +24559,8 @@ type ListPrivateNetworksRequest = {
24396
24559
  projectId?: string;
24397
24560
  /** The PrivateNetwork IDs on which to filter the returned private networks. */
24398
24561
  privateNetworkIds?: string[];
24562
+ /** Include regional Private Networks. */
24563
+ includeRegional?: boolean;
24399
24564
  };
24400
24565
  type CreatePrivateNetworkRequest = {
24401
24566
  /** Zone to target. If none is passed will use default zone from the config. */