@scaleway/sdk 2.72.0 → 2.73.0

package/dist/api/redis/v1/api.gen.js

@@ -20,10 +20,7 @@ class API extends API$1 {
     "pl-waw-2"
   ];
   /**
-   * Create a Redis™ Database Instance. Create a new Redis™ Database Instance
-   * (Redis™ cluster). You must set the `zone`, `project_id`, `version`,
-   * `node_type`, `user_name` and `password` parameters. Optionally you can
-   * define `acl_rules`, `endpoints`, `tls_enabled` and `cluster_settings`.
+   * Create a Redis™ Database Instance. Create a new Redis™ Database Instance (Redis™ cluster). You must set the `zone`, `project_id`, `version`, `node_type`, `user_name` and `password` parameters. Optionally you can define `acl_rules`, `endpoints`, `tls_enabled` and `cluster_settings`.
    *
    * @param request - The request {@link CreateClusterRequest}
    * @returns A Promise of Cluster
@@ -40,9 +37,7 @@ class API extends API$1 {
     unmarshalCluster
   );
   /**
-   * Update a Redis™ Database Instance. Update the parameters of a Redis™
-   * Database Instance (Redis™ cluster), including `name`, `tags`, `user_name`
-   * and `password`.
+   * Update a Redis™ Database Instance. Update the parameters of a Redis™ Database Instance (Redis™ cluster), including `name`, `tags`, `user_name` and `password`.
    *
    * @param request - The request {@link UpdateClusterRequest}
    * @returns A Promise of Cluster
@@ -59,11 +54,7 @@ class API extends API$1 {
     unmarshalCluster
   );
   /**
-   * Get a Redis™ Database Instance. Retrieve information about a Redis™
-   * Database Instance (Redis™ cluster). Specify the `cluster_id` and `region`
-   * in your request to get information such as `id`, `status`, `version`,
-   * `tls_enabled`, `cluster_settings`, `upgradable_versions` and `endpoints`
-   * about your cluster in the response.
+   * Get a Redis™ Database Instance. Retrieve information about a Redis™ Database Instance (Redis™ cluster). Specify the `cluster_id` and `region` in your request to get information such as `id`, `status`, `version`, `tls_enabled`, `cluster_settings`, `upgradable_versions` and `endpoints` about your cluster in the response.
    *
    * @param request - The request {@link GetClusterRequest}
    * @returns A Promise of Cluster
@@ -111,25 +102,14 @@ class API extends API$1 {
     unmarshalListClustersResponse
   );
   /**
-   * List Redis™ Database Instances. List all Redis™ Database Instances (Redis™
-   * cluster) in the specified zone. By default, the Database Instances returned
-   * in the list are ordered by creation date in ascending order, though this
-   * can be modified via the order_by field. You can define additional
-   * parameters for your query, such as `tags`, `name`, `organization_id` and
-   * `version`.
+   * List Redis™ Database Instances. List all Redis™ Database Instances (Redis™ cluster) in the specified zone. By default, the Database Instances returned in the list are ordered by creation date in ascending order, though this can be modified via the order_by field. You can define additional parameters for your query, such as `tags`, `name`, `organization_id` and `version`.
    *
    * @param request - The request {@link ListClustersRequest}
    * @returns A Promise of ListClustersResponse
    */
   listClusters = (request = {}) => enrichForPagination("clusters", this.pageOfListClusters, request);
   /**
-   * Scale up a Redis™ Database Instance. Upgrade your Redis™ Database Instance,
-   * either by upgrading to a bigger node type (vertical scaling) or by adding
-   * more nodes to your Database Instance to increase your number of endpoints
-   * and distribute cache (horizontal scaling, available for clusters only).
-   * Note that scaling horizontally your Redis™ Database Instance will not renew
-   * its TLS certificate. In order to refresh the TLS certificate, you must use
-   * the Renew TLS certificate endpoint.
+   * Scale up a Redis™ Database Instance. Upgrade your Redis™ Database Instance, either by upgrading to a bigger node type (vertical scaling) or by adding more nodes to your Database Instance to increase your number of endpoints and distribute cache (horizontal scaling, available for clusters only). Note that scaling horizontally your Redis™ Database Instance will not renew its TLS certificate. In order to refresh the TLS certificate, you must use the Renew TLS certificate endpoint.
    *
    * @param request - The request {@link MigrateClusterRequest}
    * @returns A Promise of Cluster
@@ -146,10 +126,7 @@ class API extends API$1 {
     unmarshalCluster
   );
   /**
-   * Delete a Redis™ Database Instance. Delete a Redis™ Database Instance
-   * (Redis™ cluster), specified by the `region` and `cluster_id` parameters.
-   * Deleting a Database Instance is permanent, and cannot be undone. Note that
-   * upon deletion all your data will be lost.
+   * Delete a Redis™ Database Instance. Delete a Redis™ Database Instance (Redis™ cluster), specified by the `region` and `cluster_id` parameters. Deleting a Database Instance is permanent, and cannot be undone. Note that upon deletion all your data will be lost.
    *
    * @param request - The request {@link DeleteClusterRequest}
    * @returns A Promise of Cluster
@@ -162,9 +139,7 @@ class API extends API$1 {
     unmarshalCluster
   );
   /**
-   * Get metrics of a Redis™ Database Instance. Retrieve the metrics of a Redis™
-   * Database Instance (Redis™ cluster). You can define the period from which to
-   * retrieve metrics by specifying the `start_date` and `end_date`.
+   * Get metrics of a Redis™ Database Instance. Retrieve the metrics of a Redis™ Database Instance (Redis™ cluster). You can define the period from which to retrieve metrics by specifying the `start_date` and `end_date`.
    *
    * @param request - The request {@link GetClusterMetricsRequest}
    * @returns A Promise of ClusterMetricsResponse
@@ -197,9 +172,7 @@ class API extends API$1 {
     unmarshalListNodeTypesResponse
   );
   /**
-   * List available node types. List all available node types. By default, the
-   * node types returned in the list are ordered by creation date in ascending
-   * order, though this can be modified via the `order_by` field.
+   * List available node types. List all available node types. By default, the node types returned in the list are ordered by creation date in ascending order, though this can be modified via the `order_by` field.
    *
    * @param request - The request {@link ListNodeTypesRequest}
    * @returns A Promise of ListNodeTypesResponse
@@ -224,18 +197,14 @@ class API extends API$1 {
     unmarshalListClusterVersionsResponse
   );
   /**
-   * List available Redis™ versions. List the Redis™ database engine versions
-   * available. You can define additional parameters for your query, such as
-   * `include_disabled`, `include_beta`, `include_deprecated` and `version`.
+   * List available Redis™ versions. List the Redis™ database engine versions available. You can define additional parameters for your query, such as `include_disabled`, `include_beta`, `include_deprecated` and `version`.
    *
    * @param request - The request {@link ListClusterVersionsRequest}
    * @returns A Promise of ListClusterVersionsResponse
    */
   listClusterVersions = (request) => enrichForPagination("versions", this.pageOfListClusterVersions, request);
   /**
-   * Get the TLS certificate of a cluster. Retrieve information about the TLS
-   * certificate of a Redis™ Database Instance (Redis™ cluster). Details like
-   * name and content are returned in the response.
+   * Get the TLS certificate of a cluster. Retrieve information about the TLS certificate of a Redis™ Database Instance (Redis™ cluster). Details like name and content are returned in the response.
    *
    * @param request - The request {@link GetClusterCertificateRequest}
    * @returns A Promise of Blob
@@ -247,11 +216,7 @@ class API extends API$1 {
     responseType: "blob"
   });
   /**
-   * Renew the TLS certificate of a cluster. Renew a TLS certificate for a
-   * Redis™ Database Instance (Redis™ cluster). Renewing a certificate means
-   * that you will not be able to connect to your Database Instance using the
-   * previous certificate. You will also need to download and update the new
-   * certificate for all database clients.
+   * Renew the TLS certificate of a cluster. Renew a TLS certificate for a Redis™ Database Instance (Redis™ cluster). Renewing a certificate means that you will not be able to connect to your Database Instance using the previous certificate. You will also need to download and update the new certificate for all database clients.
    *
    * @param request - The request {@link RenewClusterCertificateRequest}
    * @returns A Promise of Cluster
@@ -266,9 +231,7 @@ class API extends API$1 {
     unmarshalCluster
   );
   /**
-   * Add advanced settings. Add an advanced setting to a Redis™ Database
-   * Instance (Redis™ cluster). You must set the `name` and the `value` of each
-   * setting.
+   * Add advanced settings. Add an advanced setting to a Redis™ Database Instance (Redis™ cluster). You must set the `name` and the `value` of each setting.
    *
    * @param request - The request {@link AddClusterSettingsRequest}
    * @returns A Promise of ClusterSettingsResponse
@@ -285,9 +248,7 @@ class API extends API$1 {
     unmarshalClusterSettingsResponse
   );
   /**
-   * Delete advanced setting. Delete an advanced setting in a Redis™ Database
-   * Instance (Redis™ cluster). You must specify the names of the settings you
-   * want to delete in the request body.
+   * Delete advanced setting. Delete an advanced setting in a Redis™ Database Instance (Redis™ cluster). You must specify the names of the settings you want to delete in the request body.
    *
    * @param request - The request {@link DeleteClusterSettingRequest}
    * @returns A Promise of Cluster
@@ -300,9 +261,7 @@ class API extends API$1 {
     unmarshalCluster
   );
   /**
-   * Set advanced settings. Update an advanced setting for a Redis™ Database
-   * Instance (Redis™ cluster). Settings added upon database engine
-   * initalization can only be defined once, and cannot, therefore, be updated.
+   * Set advanced settings. Update an advanced setting for a Redis™ Database Instance (Redis™ cluster). Settings added upon database engine initalization can only be defined once, and cannot, therefore, be updated.
    *
    * @param request - The request {@link SetClusterSettingsRequest}
    * @returns A Promise of ClusterSettingsResponse
@@ -319,8 +278,7 @@ class API extends API$1 {
     unmarshalClusterSettingsResponse
   );
   /**
-   * Set ACL rules for a cluster. Replace all the ACL rules of a Redis™ Database
-   * Instance (Redis™ cluster).
+   * Set ACL rules for a cluster. Replace all the ACL rules of a Redis™ Database Instance (Redis™ cluster).
    *
    * @param request - The request {@link SetAclRulesRequest}
    * @returns A Promise of SetAclRulesResponse
@@ -337,8 +295,7 @@ class API extends API$1 {
     unmarshalSetAclRulesResponse
   );
   /**
-   * Add ACL rules for a cluster. Add an additional ACL rule to a Redis™
-   * Database Instance (Redis™ cluster).
+   * Add ACL rules for a cluster. Add an additional ACL rule to a Redis™ Database Instance (Redis™ cluster).
    *
    * @param request - The request {@link AddAclRulesRequest}
    * @returns A Promise of AddAclRulesResponse
@@ -355,9 +312,7 @@ class API extends API$1 {
     unmarshalAddAclRulesResponse
   );
   /**
-   * Delete an ACL rule for a cluster. Delete an ACL rule of a Redis™ Database
-   * Instance (Redis™ cluster). You must specify the `acl_id` of the rule you
-   * want to delete in your request.
+   * Delete an ACL rule for a cluster. Delete an ACL rule of a Redis™ Database Instance (Redis™ cluster). You must specify the `acl_id` of the rule you want to delete in your request.
    *
    * @param request - The request {@link DeleteAclRuleRequest}
    * @returns A Promise of Cluster
@@ -370,9 +325,7 @@ class API extends API$1 {
     unmarshalCluster
   );
   /**
-   * Get an ACL rule. Retrieve information about an ACL rule of a Redis™
-   * Database Instance (Redis™ cluster). You must specify the `acl_id` of the
-   * rule in your request.
+   * Get an ACL rule. Retrieve information about an ACL rule of a Redis™ Database Instance (Redis™ cluster). You must specify the `acl_id` of the rule in your request.
    *
    * @param request - The request {@link GetAclRuleRequest}
    * @returns A Promise of ACLRule
@@ -385,9 +338,7 @@ class API extends API$1 {
     unmarshalACLRule
   );
   /**
-   * Set endpoints for a cluster. Update an endpoint for a Redis™ Database
-   * Instance (Redis™ cluster). You must specify the `cluster_id` and the
-   * `endpoints` parameters in your request.
+   * Set endpoints for a cluster. Update an endpoint for a Redis™ Database Instance (Redis™ cluster). You must specify the `cluster_id` and the `endpoints` parameters in your request.
    *
    * @param request - The request {@link SetEndpointsRequest}
    * @returns A Promise of SetEndpointsResponse
@@ -404,9 +355,7 @@ class API extends API$1 {
     unmarshalSetEndpointsResponse
   );
   /**
-   * Add endpoints for a cluster. Add a new endpoint for a Redis™ Database
-   * Instance (Redis™ cluster). You can add `private_network` or
-   * `public_network` specifications to the body of the request.
+   * Add endpoints for a cluster. Add a new endpoint for a Redis™ Database Instance (Redis™ cluster). You can add `private_network` or `public_network` specifications to the body of the request.
    *
    * @param request - The request {@link AddEndpointsRequest}
    * @returns A Promise of AddEndpointsResponse
@@ -423,10 +372,7 @@ class API extends API$1 {
     unmarshalAddEndpointsResponse
   );
   /**
-   * Delete an endpoint for a cluster. Delete the endpoint of a Redis™ Database
-   * Instance (Redis™ cluster). You must specify the `region` and `endpoint_id`
-   * parameters of the endpoint you want to delete. Note that might need to
-   * update any environment configurations that point to the deleted endpoint.
+   * Delete an endpoint for a cluster. Delete the endpoint of a Redis™ Database Instance (Redis™ cluster). You must specify the `region` and `endpoint_id` parameters of the endpoint you want to delete. Note that might need to update any environment configurations that point to the deleted endpoint.
    *
    * @param request - The request {@link DeleteEndpointRequest}
    * @returns A Promise of Cluster
@@ -439,10 +385,7 @@ class API extends API$1 {
     unmarshalCluster
   );
   /**
-   * Get an endpoint. Retrieve information about a Redis™ Database Instance
-   * (Redis™ cluster) endpoint. Full details about the endpoint, like `ips`,
-   * `port`, `private_network` and `public_network` specifications are returned
-   * in the response.
+   * Get an endpoint. Retrieve information about a Redis™ Database Instance (Redis™ cluster) endpoint. Full details about the endpoint, like `ips`, `port`, `private_network` and `public_network` specifications are returned in the response.
    *
    * @param request - The request {@link GetEndpointRequest}
    * @returns A Promise of Endpoint
@@ -455,10 +398,7 @@ class API extends API$1 {
     unmarshalEndpoint
   );
   /**
-   * Update an endpoint. Update information about a Redis™ Database Instance
-   * (Redis™ cluster) endpoint. Full details about the endpoint, like `ips`,
-   * `port`, `private_network` and `public_network` specifications are returned
-   * in the response.
+   * Update an endpoint. Update information about a Redis™ Database Instance (Redis™ cluster) endpoint. Full details about the endpoint, like `ips`, `port`, `private_network` and `public_network` specifications are returned in the response.
    *
    * @param request - The request {@link UpdateEndpointRequest}
    * @returns A Promise of Endpoint