kb-cloud-client-typescript 2.3.0-alpha.134 → 2.3.0-alpha.136

package/dist/adminapi/apis/dms-api.js

@@ -76,6 +76,72 @@ const DmsApiAxiosParamCreator = function (configuration) {
                 options: localVarRequestOptions,
             };
         },
+        /**
+         * Returns an instant sample analysis for Redis keys. The result is not a persisted or full historical report; callers must use progress.complete, progress.processed, progress.sampleLimit, and generatedAt to present the sampling boundary.
+         * @summary analyze Redis keys by bounded SCAN sampling
+         * @param {string} orgName
+         * @param {string} clusterName
+         * @param {string} id
+         * @param {number} [database]
+         * @param {string} [match] Redis SCAN match pattern.
+         * @param {string} [cursor] Cursor returned by a previous analysis scan. Empty starts a new sample scan.
+         * @param {number} [sampleLimit] Maximum number of keys to sample in this analysis request.
+         * @param {number} [topN] Maximum number of top keys or namespaces to return.
+         * @param {string} [namespaceSeparator] Separator used to group key namespaces.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        analyzeRedisKeys: async (orgName, clusterName, id, database, match, cursor, sampleLimit, topN, namespaceSeparator, options = {}) => {
+            // verify required parameter 'orgName' is not null or undefined
+            (0, common_1.assertParamExists)('analyzeRedisKeys', 'orgName', orgName);
+            // verify required parameter 'clusterName' is not null or undefined
+            (0, common_1.assertParamExists)('analyzeRedisKeys', 'clusterName', clusterName);
+            // verify required parameter 'id' is not null or undefined
+            (0, common_1.assertParamExists)('analyzeRedisKeys', 'id', id);
+            const localVarPath = `/admin/v1/organizations/{orgName}/clusters/{clusterName}/datasource/{id}/redis/analysis`
+                .replace(`{${"orgName"}}`, encodeURIComponent(String(orgName)))
+                .replace(`{${"clusterName"}}`, encodeURIComponent(String(clusterName)))
+                .replace(`{${"id"}}`, encodeURIComponent(String(id)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+            const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
+            const localVarHeaderParameter = {};
+            const localVarQueryParameter = {};
+            // authentication BearerToken required
+            // http bearer authentication required
+            await (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
+            // authentication DigestAuth required
+            await (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "Authorization", configuration);
+            if (database !== undefined) {
+                localVarQueryParameter['database'] = database;
+            }
+            if (match !== undefined) {
+                localVarQueryParameter['match'] = match;
+            }
+            if (cursor !== undefined) {
+                localVarQueryParameter['cursor'] = cursor;
+            }
+            if (sampleLimit !== undefined) {
+                localVarQueryParameter['sampleLimit'] = sampleLimit;
+            }
+            if (topN !== undefined) {
+                localVarQueryParameter['topN'] = topN;
+            }
+            if (namespaceSeparator !== undefined) {
+                localVarQueryParameter['namespaceSeparator'] = namespaceSeparator;
+            }
+            (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
+            return {
+                url: (0, common_1.toPathString)(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
         /**
          *
          * @summary close a Redis Pub/Sub polling session
@@ -3275,6 +3341,28 @@ const DmsApiFp = function (configuration) {
             const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['DmsApi.alterParameter']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
             return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
         },
+        /**
+         * Returns an instant sample analysis for Redis keys. The result is not a persisted or full historical report; callers must use progress.complete, progress.processed, progress.sampleLimit, and generatedAt to present the sampling boundary.
+         * @summary analyze Redis keys by bounded SCAN sampling
+         * @param {string} orgName
+         * @param {string} clusterName
+         * @param {string} id
+         * @param {number} [database]
+         * @param {string} [match] Redis SCAN match pattern.
+         * @param {string} [cursor] Cursor returned by a previous analysis scan. Empty starts a new sample scan.
+         * @param {number} [sampleLimit] Maximum number of keys to sample in this analysis request.
+         * @param {number} [topN] Maximum number of top keys or namespaces to return.
+         * @param {string} [namespaceSeparator] Separator used to group key namespaces.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async analyzeRedisKeys(orgName, clusterName, id, database, match, cursor, sampleLimit, topN, namespaceSeparator, options) {
+            var _a, _b, _c;
+            const localVarAxiosArgs = await localVarAxiosParamCreator.analyzeRedisKeys(orgName, clusterName, id, database, match, cursor, sampleLimit, topN, namespaceSeparator, options);
+            const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
+            const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['DmsApi.analyzeRedisKeys']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
+            return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
         /**
          *
          * @summary close a Redis Pub/Sub polling session
@@ -4447,6 +4535,16 @@ const DmsApiFactory = function (configuration, basePath, axios) {
         alterParameter(requestParameters, options) {
             return localVarFp.alterParameter(requestParameters.orgName, requestParameters.clusterName, requestParameters.tenantId, requestParameters.dmsObAlterParameter, options).then((request) => request(axios, basePath));
         },
+        /**
+         * Returns an instant sample analysis for Redis keys. The result is not a persisted or full historical report; callers must use progress.complete, progress.processed, progress.sampleLimit, and generatedAt to present the sampling boundary.
+         * @summary analyze Redis keys by bounded SCAN sampling
+         * @param {DmsApiAnalyzeRedisKeysRequest} requestParameters Request parameters.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        analyzeRedisKeys(requestParameters, options) {
+            return localVarFp.analyzeRedisKeys(requestParameters.orgName, requestParameters.clusterName, requestParameters.id, requestParameters.database, requestParameters.match, requestParameters.cursor, requestParameters.sampleLimit, requestParameters.topN, requestParameters.namespaceSeparator, options).then((request) => request(axios, basePath));
+        },
         /**
          *
          * @summary close a Redis Pub/Sub polling session
@@ -5130,6 +5228,17 @@ class DmsApi extends base_1.BaseAPI {
     alterParameter(requestParameters, options) {
         return (0, exports.DmsApiFp)(this.configuration).alterParameter(requestParameters.orgName, requestParameters.clusterName, requestParameters.tenantId, requestParameters.dmsObAlterParameter, options).then((request) => request(this.axios, this.basePath));
     }
+    /**
+     * Returns an instant sample analysis for Redis keys. The result is not a persisted or full historical report; callers must use progress.complete, progress.processed, progress.sampleLimit, and generatedAt to present the sampling boundary.
+     * @summary analyze Redis keys by bounded SCAN sampling
+     * @param {DmsApiAnalyzeRedisKeysRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DmsApi
+     */
+    analyzeRedisKeys(requestParameters, options) {
+        return (0, exports.DmsApiFp)(this.configuration).analyzeRedisKeys(requestParameters.orgName, requestParameters.clusterName, requestParameters.id, requestParameters.database, requestParameters.match, requestParameters.cursor, requestParameters.sampleLimit, requestParameters.topN, requestParameters.namespaceSeparator, options).then((request) => request(this.axios, this.basePath));
+    }
     /**
      *
      * @summary close a Redis Pub/Sub polling session