@elastic/elasticsearch 9.2.0 → 9.3.0-unstable.20251027183018

package/lib/api/api/indices.d.ts

@@ -129,6 +129,13 @@ export default class Indices {
     deleteIndexTemplate(this: That, params: T.IndicesDeleteIndexTemplateRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.IndicesDeleteIndexTemplateResponse>;
     deleteIndexTemplate(this: That, params: T.IndicesDeleteIndexTemplateRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.IndicesDeleteIndexTemplateResponse, unknown>>;
     deleteIndexTemplate(this: That, params: T.IndicesDeleteIndexTemplateRequest, options?: TransportRequestOptions): Promise<T.IndicesDeleteIndexTemplateResponse>;
+    /**
+      * Delete sampling configuration for an index or data stream
+      * @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-delete-sample-configuration | Elasticsearch API documentation}
+      */
+    deleteSampleConfiguration(this: That, params?: T.TODO, options?: TransportRequestOptionsWithOutMeta): Promise<T.TODO>;
+    deleteSampleConfiguration(this: That, params?: T.TODO, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.TODO, unknown>>;
+    deleteSampleConfiguration(this: That, params?: T.TODO, options?: TransportRequestOptions): Promise<T.TODO>;
     /**
       * Delete a legacy index template. IMPORTANT: This documentation is about legacy index templates, which are deprecated and will be replaced by the composable templates introduced in Elasticsearch 7.8.
       * @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-delete-template | Elasticsearch API documentation}
@@ -290,6 +297,27 @@ export default class Indices {
     getMigrateReindexStatus(this: That, params: T.IndicesGetMigrateReindexStatusRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.IndicesGetMigrateReindexStatusResponse>;
     getMigrateReindexStatus(this: That, params: T.IndicesGetMigrateReindexStatusRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.IndicesGetMigrateReindexStatusResponse, unknown>>;
     getMigrateReindexStatus(this: That, params: T.IndicesGetMigrateReindexStatusRequest, options?: TransportRequestOptions): Promise<T.IndicesGetMigrateReindexStatusResponse>;
+    /**
+      * Request for a random sample of raw documents ingested into the given index or data stream.
+      * @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/group/ingest-random-sampling | Elasticsearch API documentation}
+      */
+    getSample(this: That, params: T.IndicesGetSampleRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.IndicesGetSampleResponse>;
+    getSample(this: That, params: T.IndicesGetSampleRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.IndicesGetSampleResponse, unknown>>;
+    getSample(this: That, params: T.IndicesGetSampleRequest, options?: TransportRequestOptions): Promise<T.IndicesGetSampleResponse>;
+    /**
+      * Get sampling configuration for an index or data stream
+      * @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-get-sample-configuration | Elasticsearch API documentation}
+      */
+    getSampleConfiguration(this: That, params?: T.TODO, options?: TransportRequestOptionsWithOutMeta): Promise<T.TODO>;
+    getSampleConfiguration(this: That, params?: T.TODO, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.TODO, unknown>>;
+    getSampleConfiguration(this: That, params?: T.TODO, options?: TransportRequestOptions): Promise<T.TODO>;
+    /**
+      * Request stats for a random sample of raw documents ingested into the given index or data stream.
+      * @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/group/ingest-random-sampling | Elasticsearch API documentation}
+      */
+    getSampleStats(this: That, params: T.IndicesGetSampleStatsRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.IndicesGetSampleStatsResponse>;
+    getSampleStats(this: That, params: T.IndicesGetSampleStatsRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.IndicesGetSampleStatsResponse, unknown>>;
+    getSampleStats(this: That, params: T.IndicesGetSampleStatsRequest, options?: TransportRequestOptions): Promise<T.IndicesGetSampleStatsResponse>;
     /**
       * Get index settings. Get setting information for one or more indices. For data streams, it returns setting information for the stream's backing indices.
       * @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-get-settings | Elasticsearch API documentation}
@@ -388,6 +416,13 @@ export default class Indices {
     putMapping(this: That, params: T.IndicesPutMappingRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.IndicesPutMappingResponse>;
     putMapping(this: That, params: T.IndicesPutMappingRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.IndicesPutMappingResponse, unknown>>;
     putMapping(this: That, params: T.IndicesPutMappingRequest, options?: TransportRequestOptions): Promise<T.IndicesPutMappingResponse>;
+    /**
+      * Configure sampling for an index or data stream
+      * @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-put-sample-configuration | Elasticsearch API documentation}
+      */
+    putSampleConfiguration(this: That, params?: T.TODO, options?: TransportRequestOptionsWithOutMeta): Promise<T.TODO>;
+    putSampleConfiguration(this: That, params?: T.TODO, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.TODO, unknown>>;
+    putSampleConfiguration(this: That, params?: T.TODO, options?: TransportRequestOptions): Promise<T.TODO>;
     /**
       * Update index settings. Changes dynamic index settings in real time. For data streams, index setting changes are applied to all backing indices by default. To revert a setting to the default value, use a null value. The list of per-index settings that can be updated dynamically on live indices can be found in index settings documentation. To preserve existing settings from being updated, set the `preserve_existing` parameter to `true`. For performance optimization during bulk indexing, you can disable the refresh interval. Refer to [disable refresh interval](https://www.elastic.co/docs/deploy-manage/production-guidance/optimize-performance/indexing-speed#disable-refresh-interval) for an example. There are multiple valid ways to represent index settings in the request body. You can specify only the setting, for example: ``` { "number_of_replicas": 1 } ``` Or you can use an `index` setting object: ``` { "index": { "number_of_replicas": 1 } } ``` Or you can use dot annotation: ``` { "index.number_of_replicas": 1 } ``` Or you can embed any of the aforementioned options in a `settings` object. For example: ``` { "settings": { "index": { "number_of_replicas": 1 } } } ``` NOTE: You can only define new analyzers on closed indices. To add an analyzer, you must close the index, define the analyzer, and reopen the index. You cannot close the write index of a data stream. To update the analyzer for a data stream's write index and future backing indices, update the analyzer in the index template used by the stream. Then roll over the data stream to apply the new analyzer to the stream's write index and future backing indices. This affects searches and any new data added to the stream after the rollover. However, it does not affect the data stream's backing indices or their existing data. To change the analyzer for existing backing indices, you must create a new data stream and reindex your data into it. Refer to [updating analyzers on existing indices](https://www.elastic.co/docs/manage-data/data-store/text-analysis/specify-an-analyzer#update-analyzers-on-existing-indices) for step-by-step examples.
       * @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-put-settings | Elasticsearch API documentation}

package/lib/api/api/indices.js

@@ -218,6 +218,13 @@ class Indices {
                     'timeout'
                 ]
             },
+            'indices.delete_sample_configuration': {
+                path: [
+                    'index'
+                ],
+                body: [],
+                query: []
+            },
             'indices.delete_template': {
                 path: [
                     'name'
@@ -480,6 +487,27 @@ class Indices {
                 body: [],
                 query: []
             },
+            'indices.get_sample': {
+                path: [
+                    'index'
+                ],
+                body: [],
+                query: []
+            },
+            'indices.get_sample_configuration': {
+                path: [
+                    'index'
+                ],
+                body: [],
+                query: []
+            },
+            'indices.get_sample_stats': {
+                path: [
+                    'index'
+                ],
+                body: [],
+                query: []
+            },
             'indices.get_settings': {
                 path: [
                     'index',
@@ -673,6 +701,13 @@ class Indices {
                     'write_index_only'
                 ]
             },
+            'indices.put_sample_configuration': {
+                path: [
+                    'index'
+                ],
+                body: [],
+                query: []
+            },
             'indices.put_settings': {
                 path: [
                     'index'
@@ -1666,6 +1701,42 @@ class Indices {
         };
         return await this.transport.request({ path, method, querystring, body, meta }, options);
     }
+    async deleteSampleConfiguration(params, options) {
+        const { path: acceptedPath } = this[client_1.kAcceptedParams]['indices.delete_sample_configuration'];
+        const userQuery = params === null || params === void 0 ? void 0 : params.querystring;
+        const querystring = userQuery != null ? { ...userQuery } : {};
+        let body;
+        const userBody = params === null || params === void 0 ? void 0 : params.body;
+        if (userBody != null) {
+            if (typeof userBody === 'string') {
+                body = userBody;
+            }
+            else {
+                body = { ...userBody };
+            }
+        }
+        params = params !== null && params !== void 0 ? params : {};
+        for (const key in params) {
+            if (acceptedPath.includes(key)) {
+                continue;
+            }
+            else if (key !== 'body' && key !== 'querystring') {
+                querystring[key] = params[key];
+            }
+        }
+        const method = 'DELETE';
+        const path = `/${encodeURIComponent(params.index.toString())}/_sample/config`;
+        const meta = {
+            name: 'indices.delete_sample_configuration',
+            pathParts: {
+                index: params.index
+            },
+            acceptedParams: [
+                'index'
+            ]
+        };
+        return await this.transport.request({ path, method, querystring, body, meta }, options);
+    }
     async deleteTemplate(params, options) {
         const { path: acceptedPath } = this[client_1.kAcceptedParams]['indices.delete_template'];
         const userQuery = params === null || params === void 0 ? void 0 : params.querystring;
@@ -2657,6 +2728,114 @@ class Indices {
         };
         return await this.transport.request({ path, method, querystring, body, meta }, options);
     }
+    async getSample(params, options) {
+        const { path: acceptedPath } = this[client_1.kAcceptedParams]['indices.get_sample'];
+        const userQuery = params === null || params === void 0 ? void 0 : params.querystring;
+        const querystring = userQuery != null ? { ...userQuery } : {};
+        let body;
+        const userBody = params === null || params === void 0 ? void 0 : params.body;
+        if (userBody != null) {
+            if (typeof userBody === 'string') {
+                body = userBody;
+            }
+            else {
+                body = { ...userBody };
+            }
+        }
+        for (const key in params) {
+            if (acceptedPath.includes(key)) {
+                continue;
+            }
+            else if (key !== 'body' && key !== 'querystring') {
+                // @ts-expect-error
+                querystring[key] = params[key];
+            }
+        }
+        const method = 'GET';
+        const path = `/${encodeURIComponent(params.index.toString())}/_sample`;
+        const meta = {
+            name: 'indices.get_sample',
+            pathParts: {
+                index: params.index
+            },
+            acceptedParams: [
+                'index'
+            ]
+        };
+        return await this.transport.request({ path, method, querystring, body, meta }, options);
+    }
+    async getSampleConfiguration(params, options) {
+        const { path: acceptedPath } = this[client_1.kAcceptedParams]['indices.get_sample_configuration'];
+        const userQuery = params === null || params === void 0 ? void 0 : params.querystring;
+        const querystring = userQuery != null ? { ...userQuery } : {};
+        let body;
+        const userBody = params === null || params === void 0 ? void 0 : params.body;
+        if (userBody != null) {
+            if (typeof userBody === 'string') {
+                body = userBody;
+            }
+            else {
+                body = { ...userBody };
+            }
+        }
+        params = params !== null && params !== void 0 ? params : {};
+        for (const key in params) {
+            if (acceptedPath.includes(key)) {
+                continue;
+            }
+            else if (key !== 'body' && key !== 'querystring') {
+                querystring[key] = params[key];
+            }
+        }
+        const method = 'GET';
+        const path = `/${encodeURIComponent(params.index.toString())}/_sample/config`;
+        const meta = {
+            name: 'indices.get_sample_configuration',
+            pathParts: {
+                index: params.index
+            },
+            acceptedParams: [
+                'index'
+            ]
+        };
+        return await this.transport.request({ path, method, querystring, body, meta }, options);
+    }
+    async getSampleStats(params, options) {
+        const { path: acceptedPath } = this[client_1.kAcceptedParams]['indices.get_sample_stats'];
+        const userQuery = params === null || params === void 0 ? void 0 : params.querystring;
+        const querystring = userQuery != null ? { ...userQuery } : {};
+        let body;
+        const userBody = params === null || params === void 0 ? void 0 : params.body;
+        if (userBody != null) {
+            if (typeof userBody === 'string') {
+                body = userBody;
+            }
+            else {
+                body = { ...userBody };
+            }
+        }
+        for (const key in params) {
+            if (acceptedPath.includes(key)) {
+                continue;
+            }
+            else if (key !== 'body' && key !== 'querystring') {
+                // @ts-expect-error
+                querystring[key] = params[key];
+            }
+        }
+        const method = 'GET';
+        const path = `/${encodeURIComponent(params.index.toString())}/_sample/stats`;
+        const meta = {
+            name: 'indices.get_sample_stats',
+            pathParts: {
+                index: params.index
+            },
+            acceptedParams: [
+                'index'
+            ]
+        };
+        return await this.transport.request({ path, method, querystring, body, meta }, options);
+    }
     async getSettings(params, options) {
         const { path: acceptedPath } = this[client_1.kAcceptedParams]['indices.get_settings'];
         const userQuery = params === null || params === void 0 ? void 0 : params.querystring;
@@ -3348,6 +3527,42 @@ class Indices {
         };
         return await this.transport.request({ path, method, querystring, body, meta }, options);
     }
+    async putSampleConfiguration(params, options) {
+        const { path: acceptedPath } = this[client_1.kAcceptedParams]['indices.put_sample_configuration'];
+        const userQuery = params === null || params === void 0 ? void 0 : params.querystring;
+        const querystring = userQuery != null ? { ...userQuery } : {};
+        let body;
+        const userBody = params === null || params === void 0 ? void 0 : params.body;
+        if (userBody != null) {
+            if (typeof userBody === 'string') {
+                body = userBody;
+            }
+            else {
+                body = { ...userBody };
+            }
+        }
+        params = params !== null && params !== void 0 ? params : {};
+        for (const key in params) {
+            if (acceptedPath.includes(key)) {
+                continue;
+            }
+            else if (key !== 'body' && key !== 'querystring') {
+                querystring[key] = params[key];
+            }
+        }
+        const method = 'PUT';
+        const path = `/${encodeURIComponent(params.index.toString())}/_sample/config`;
+        const meta = {
+            name: 'indices.put_sample_configuration',
+            pathParts: {
+                index: params.index
+            },
+            acceptedParams: [
+                'index'
+            ]
+        };
+        return await this.transport.request({ path, method, querystring, body, meta }, options);
+    }
     async putSettings(params, options) {
         var _b;
         const { path: acceptedPath, body: acceptedBody, query: acceptedQuery } = this[client_1.kAcceptedParams]['indices.put_settings'];