habsi/elasticsearch-js
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Auto-generated code for main (#2317)

Browse Source
This commit is contained in:
Elastic Machine
2024-07-30 01:27:15 +10:00
committed by GitHub
parent 384debee9e
commit 94da0d241a
32 changed files with 273 additions and 170 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
src/api/api/bulk.ts
View File

@ -39,7 +39,7 @@ import * as TB from '../typesWithBodyKey'
interface That { transport: Transport }
/**
* Performs multiple indexing or delete operations in a single API call. This reduces overhead and can greatly increase indexing speed.
* Bulk index or delete documents. Performs multiple indexing or delete operations in a single API call. This reduces overhead and can greatly increase indexing speed.
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-bulk.html | Elasticsearch API documentation}
*/
export default async function BulkApi<TDocument = unknown, TPartialDocument = unknown> (this: That, params: T.BulkRequest<TDocument, TPartialDocument> | TB.BulkRequest<TDocument, TPartialDocument>, options?: TransportRequestOptionsWithOutMeta): Promise<T.BulkResponse>

20
src/api/api/cat.ts
View File

@ -45,7 +45,7 @@ export default class Cat {
}
/**
* Retrieves the cluster’s index aliases, including filter and routing information. The API does not return data stream aliases. IMPORTANT: cat APIs are only intended for human consumption using the command line or the Kibana console. They are not intended for use by applications. For application consumption, use the aliases API.
* Get aliases. Retrieves the cluster’s index aliases, including filter and routing information. The API does not return data stream aliases. > info > CAT APIs are only intended for human consumption using the command line or the Kibana console. They are not intended for use by applications. For application consumption, use [the /_alias endpoints](#endpoint-alias).
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-alias.html | Elasticsearch API documentation}
*/
async aliases (this: That, params?: T.CatAliasesRequest | TB.CatAliasesRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.CatAliasesResponse>
@ -125,7 +125,7 @@ export default class Cat {
}
/**
* Returns information about component templates in a cluster. Component templates are building blocks for constructing index templates that specify index mappings, settings, and aliases. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the get component template API.
* Get component templates. Returns information about component templates in a cluster. Component templates are building blocks for constructing index templates that specify index mappings, settings, and aliases. > info > CAT APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use [the /_component_template endpoints](#endpoint-component-template).
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-component-templates.html | Elasticsearch API documentation}
*/
async componentTemplates (this: That, params?: T.CatComponentTemplatesRequest | TB.CatComponentTemplatesRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.CatComponentTemplatesResponse>
@ -165,7 +165,7 @@ export default class Cat {
}
/**
* Provides quick access to a document count for a data stream, an index, or an entire cluster. NOTE: The document count only includes live documents, not deleted documents which have not yet been removed by the merge process. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the count API.
* Get a document count. Provides quick access to a document count for a data stream, an index, or an entire cluster.n/ The document count only includes live documents, not deleted documents which have not yet been removed by the merge process. > info > CAT APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use [the /_count endpoints](#endpoint-count).
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-count.html | Elasticsearch API documentation}
*/
async count (this: That, params?: T.CatCountRequest | TB.CatCountRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.CatCountResponse>
@ -275,7 +275,7 @@ export default class Cat {
}
/**
* Returns help for the Cat APIs.
* Get CAT help. Returns help for the CAT APIs.
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/cat.html | Elasticsearch API documentation}
*/
async help (this: That, params?: T.CatHelpRequest | TB.CatHelpRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.CatHelpResponse>
@ -305,7 +305,7 @@ export default class Cat {
}
/**
* Returns high-level information about indices in a cluster, including backing indices for data streams. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the get index API. Use the cat indices API to get the following information for each index in a cluster: shard count; document count; deleted document count; primary store size; total store size of all shards, including shard replicas. These metrics are retrieved directly from Lucene, which Elasticsearch uses internally to power indexing and search. As a result, all document counts include hidden nested documents. To get an accurate count of Elasticsearch documents, use the cat count or count APIs.
* Get index information. Returns high-level information about indices in a cluster, including backing indices for data streams. > info > CAT APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use an index endpoint. Use this request to get the following information for each index in a cluster: - shard count - document count - deleted document count - primary store size - total store size of all shards, including shard replicas These metrics are retrieved directly from Lucene, which Elasticsearch uses internally to power indexing and search. As a result, all document counts include hidden nested documents. To get an accurate count of Elasticsearch documents, use the [/_cat/count](#operation-cat-count) or [count](#endpoint-count) endpoints.
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-indices.html | Elasticsearch API documentation}
*/
async indices (this: That, params?: T.CatIndicesRequest | TB.CatIndicesRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.CatIndicesResponse>
@ -375,7 +375,7 @@ export default class Cat {
}
/**
* Returns configuration and usage information about data frame analytics jobs. IMPORTANT: cat APIs are only intended for human consumption using the Kibana console or command line. They are not intended for use by applications. For application consumption, use the get data frame analytics jobs statistics API.
* Get data frame analytics jobs. Returns configuration and usage information about data frame analytics jobs. > info > CAT APIs are only intended for human consumption using the Kibana console or command line. They are not intended for use by applications. For application consumption, use [the /_ml/data_frame/analytics endpoints](#endpoint-ml).
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-dfanalytics.html | Elasticsearch API documentation}
*/
async mlDataFrameAnalytics (this: That, params?: T.CatMlDataFrameAnalyticsRequest | TB.CatMlDataFrameAnalyticsRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.CatMlDataFrameAnalyticsResponse>
@ -415,7 +415,7 @@ export default class Cat {
}
/**
* Returns configuration and usage information about datafeeds. This API returns a maximum of 10,000 datafeeds. If the Elasticsearch security features are enabled, you must have `monitor_ml`, `monitor`, `manage_ml`, or `manage` cluster privileges to use this API. IMPORTANT: cat APIs are only intended for human consumption using the Kibana console or command line. They are not intended for use by applications. For application consumption, use the get datafeed statistics API.
* Get datafeeds. Returns configuration and usage information about datafeeds. This API returns a maximum of 10,000 datafeeds. If the Elasticsearch security features are enabled, you must have `monitor_ml`, `monitor`, `manage_ml`, or `manage` cluster privileges to use this API. > info > CAT APIs are only intended for human consumption using the Kibana console or command line. They are not intended for use by applications. For application consumption, use [the /_ml/datafeeds endpoints](#endpoint-ml).
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-datafeeds.html | Elasticsearch API documentation}
*/
async mlDatafeeds (this: That, params?: T.CatMlDatafeedsRequest | TB.CatMlDatafeedsRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.CatMlDatafeedsResponse>
@ -455,7 +455,7 @@ export default class Cat {
}
/**
* Returns configuration and usage information for anomaly detection jobs. This API returns a maximum of 10,000 jobs. If the Elasticsearch security features are enabled, you must have `monitor_ml`, `monitor`, `manage_ml`, or `manage` cluster privileges to use this API. IMPORTANT: cat APIs are only intended for human consumption using the Kibana console or command line. They are not intended for use by applications. For application consumption, use the get anomaly detection job statistics API.
* Get anomaly detection jobs. Returns configuration and usage information for anomaly detection jobs. This API returns a maximum of 10,000 jobs. If the Elasticsearch security features are enabled, you must have `monitor_ml`, `monitor`, `manage_ml`, or `manage` cluster privileges to use this API. > info > CAT APIs are only intended for human consumption using the Kibana console or command line. They are not intended for use by applications. For application consumption, use [the /_ml/anomaly_detectors endpoints](#endpoint-ml).
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-anomaly-detectors.html | Elasticsearch API documentation}
*/
async mlJobs (this: That, params?: T.CatMlJobsRequest | TB.CatMlJobsRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.CatMlJobsResponse>
@ -495,7 +495,7 @@ export default class Cat {
}
/**
* Returns configuration and usage information about inference trained models. IMPORTANT: cat APIs are only intended for human consumption using the Kibana console or command line. They are not intended for use by applications. For application consumption, use the get trained models statistics API.
* Get trained models. Returns configuration and usage information about inference trained models. > info > CAT APIs are only intended for human consumption using the Kibana console or command line. They are not intended for use by applications. For application consumption, use [the /_ml/trained_models endpoints](#endpoint-ml).
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-trained-model.html | Elasticsearch API documentation}
*/
async mlTrainedModels (this: That, params?: T.CatMlTrainedModelsRequest | TB.CatMlTrainedModelsRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.CatMlTrainedModelsResponse>
@ -955,7 +955,7 @@ export default class Cat {
}
/**
* Returns configuration and usage information about transforms. IMPORTANT: cat APIs are only intended for human consumption using the Kibana console or command line. They are not intended for use by applications. For application consumption, use the get transform statistics API.
* Get transforms. Returns configuration and usage information about transforms. > info > CAT APIs are only intended for human consumption using the Kibana console or command line. They are not intended for use by applications. For application consumption, use [the /_transform endpoints](#endpoint-transform).
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-transforms.html | Elasticsearch API documentation}
*/
async transforms (this: That, params?: T.CatTransformsRequest | TB.CatTransformsRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.CatTransformsResponse>

10
src/api/api/cluster.ts
View File

@ -87,7 +87,7 @@ export default class Cluster {
}
/**
* Deletes component templates. Component templates are building blocks for constructing index templates that specify index mappings, settings, and aliases.
* Delete component templates. Deletes component templates. Component templates are building blocks for constructing index templates that specify index mappings, settings, and aliases.
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-component-template.html | Elasticsearch API documentation}
*/
async deleteComponentTemplate (this: That, params: T.ClusterDeleteComponentTemplateRequest | TB.ClusterDeleteComponentTemplateRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.ClusterDeleteComponentTemplateResponse>
@ -149,7 +149,7 @@ export default class Cluster {
}
/**
* Returns information about whether a particular component template exist
* Check component templates. Returns information about whether a particular component template exists.
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-component-template.html | Elasticsearch API documentation}
*/
async existsComponentTemplate (this: That, params: T.ClusterExistsComponentTemplateRequest | TB.ClusterExistsComponentTemplateRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.ClusterExistsComponentTemplateResponse>
@ -181,7 +181,7 @@ export default class Cluster {
}
/**
* Retrieves information about component templates.
* Get component templates. Retrieves information about component templates.
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-component-template.html | Elasticsearch API documentation}
*/
async getComponentTemplate (this: That, params?: T.ClusterGetComponentTemplateRequest | TB.ClusterGetComponentTemplateRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.ClusterGetComponentTemplateResponse>
@ -291,7 +291,7 @@ export default class Cluster {
}
/**
* Returns different information about the cluster.
* Get cluster info. Returns basic information about the cluster.
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-info.html | Elasticsearch API documentation}
*/
async info (this: That, params: T.ClusterInfoRequest | TB.ClusterInfoRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.ClusterInfoResponse>
@ -383,7 +383,7 @@ export default class Cluster {
}
/**
* Creates or updates a component template. Component templates are building blocks for constructing index templates that specify index mappings, settings, and aliases. An index template can be composed of multiple component templates. To use a component template, specify it in an index template’s `composed_of` list. Component templates are only applied to new data streams and indices as part of a matching index template. Settings and mappings specified directly in the index template or the create index request override any settings or mappings specified in a component template. Component templates are only used during index creation. For data streams, this includes data stream creation and the creation of a stream’s backing indices. Changes to component templates do not affect existing indices, including a stream’s backing indices. You can use C-style `/* *\/` block comments in component templates. You can include comments anywhere in the request body except before the opening curly bracket.
* Create or update a component template. Creates or updates a component template. Component templates are building blocks for constructing index templates that specify index mappings, settings, and aliases. An index template can be composed of multiple component templates. To use a component template, specify it in an index template’s `composed_of` list. Component templates are only applied to new data streams and indices as part of a matching index template. Settings and mappings specified directly in the index template or the create index request override any settings or mappings specified in a component template. Component templates are only used during index creation. For data streams, this includes data stream creation and the creation of a stream’s backing indices. Changes to component templates do not affect existing indices, including a stream’s backing indices. You can use C-style `/* *\/` block comments in component templates. You can include comments anywhere in the request body except before the opening curly bracket.
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-component-template.html | Elasticsearch API documentation}
*/
async putComponentTemplate (this: That, params: T.ClusterPutComponentTemplateRequest | TB.ClusterPutComponentTemplateRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.ClusterPutComponentTemplateResponse>

2
src/api/api/create.ts
View File

@ -39,7 +39,7 @@ import * as TB from '../typesWithBodyKey'
interface That { transport: Transport }
/**
* Adds a JSON document to the specified data stream or index and makes it searchable. If the target is an index and the document already exists, the request updates the document and increments its version.
* Index a document. Adds a JSON document to the specified data stream or index and makes it searchable. If the target is an index and the document already exists, the request updates the document and increments its version.
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-index_.html | Elasticsearch API documentation}
*/
export default async function CreateApi<TDocument = unknown> (this: That, params: T.CreateRequest<TDocument> | TB.CreateRequest<TDocument>, options?: TransportRequestOptionsWithOutMeta): Promise<T.CreateResponse>

2
src/api/api/delete.ts
View File

@ -39,7 +39,7 @@ import * as TB from '../typesWithBodyKey'
interface That { transport: Transport }
/**
* Removes a JSON document from the specified index.
* Delete a document. Removes a JSON document from the specified index.
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-delete.html | Elasticsearch API documentation}
*/
export default async function DeleteApi (this: That, params: T.DeleteRequest | TB.DeleteRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.DeleteResponse>

2
src/api/api/delete_by_query.ts
View File

@ -39,7 +39,7 @@ import * as TB from '../typesWithBodyKey'
interface That { transport: Transport }
/**
* Deletes documents that match the specified query.
* Delete documents. Deletes documents that match the specified query.
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-delete-by-query.html | Elasticsearch API documentation}
*/
export default async function DeleteByQueryApi (this: That, params: T.DeleteByQueryRequest | TB.DeleteByQueryRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.DeleteByQueryResponse>

2
src/api/api/delete_script.ts
View File

@ -39,7 +39,7 @@ import * as TB from '../typesWithBodyKey'
interface That { transport: Transport }
/**
* Deletes a stored script or search template.
* Delete a script or search template. Deletes a stored script or search template.
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-scripting.html | Elasticsearch API documentation}
*/
export default async function DeleteScriptApi (this: That, params: T.DeleteScriptRequest | TB.DeleteScriptRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.DeleteScriptResponse>

8
src/api/api/enrich.ts
View File

@ -45,7 +45,7 @@ export default class Enrich {
}
/**
* Deletes an existing enrich policy and its enrich index.
* Delete an enrich policy. Deletes an existing enrich policy and its enrich index.
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/delete-enrich-policy-api.html | Elasticsearch API documentation}
*/
async deletePolicy (this: That, params: T.EnrichDeletePolicyRequest | TB.EnrichDeletePolicyRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.EnrichDeletePolicyResponse>
@ -109,7 +109,7 @@ export default class Enrich {
}
/**
* Returns information about an enrich policy.
* Get an enrich policy. Returns information about an enrich policy.
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/get-enrich-policy-api.html | Elasticsearch API documentation}
*/
async getPolicy (this: That, params?: T.EnrichGetPolicyRequest | TB.EnrichGetPolicyRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.EnrichGetPolicyResponse>
@ -149,7 +149,7 @@ export default class Enrich {
}
/**
* Creates an enrich policy.
* Create an enrich policy. Creates an enrich policy.
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/put-enrich-policy-api.html | Elasticsearch API documentation}
*/
async putPolicy (this: That, params: T.EnrichPutPolicyRequest | TB.EnrichPutPolicyRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.EnrichPutPolicyResponse>
@ -193,7 +193,7 @@ export default class Enrich {
}
/**
* Returns enrich coordinator statistics and information about enrich policies that are currently executing.
* Get enrich stats. Returns enrich coordinator statistics and information about enrich policies that are currently executing.
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/enrich-stats-api.html | Elasticsearch API documentation}
*/
async stats (this: That, params?: T.EnrichStatsRequest | TB.EnrichStatsRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.EnrichStatsResponse>

2
src/api/api/exists.ts
View File

@ -39,7 +39,7 @@ import * as TB from '../typesWithBodyKey'
interface That { transport: Transport }
/**
* Checks if a document in an index exists.
* Check a document. Checks if a specified document exists.
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-get.html | Elasticsearch API documentation}
*/
export default async function ExistsApi (this: That, params: T.ExistsRequest | TB.ExistsRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.ExistsResponse>

2
src/api/api/exists_source.ts
View File

@ -39,7 +39,7 @@ import * as TB from '../typesWithBodyKey'
interface That { transport: Transport }
/**
* Checks if a document's `_source` is stored.
* Check for a document source. Checks if a document's `_source` is stored.
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-get.html | Elasticsearch API documentation}
*/
export default async function ExistsSourceApi (this: That, params: T.ExistsSourceRequest | TB.ExistsSourceRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.ExistsSourceResponse>

2
src/api/api/explain.ts
View File

@ -39,7 +39,7 @@ import * as TB from '../typesWithBodyKey'
interface That { transport: Transport }
/**
* Returns information about why a specific document matches (or doesn’t match) a query.
* Explain a document match result. Returns information about why a specific document matches, or doesn’t match, a query.
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/search-explain.html | Elasticsearch API documentation}
*/
export default async function ExplainApi<TDocument = unknown> (this: That, params: T.ExplainRequest | TB.ExplainRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.ExplainResponse<TDocument>>

2
src/api/api/get.ts
View File

@ -39,7 +39,7 @@ import * as TB from '../typesWithBodyKey'
interface That { transport: Transport }
/**
* Returns a document.
* Get a document by its ID. Retrieves the document with the specified ID from an index.
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-get.html | Elasticsearch API documentation}
*/
export default async function GetApi<TDocument = unknown> (this: That, params: T.GetRequest | TB.GetRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.GetResponse<TDocument>>

2
src/api/api/get_script.ts
View File

@ -39,7 +39,7 @@ import * as TB from '../typesWithBodyKey'
interface That { transport: Transport }
/**
* Retrieves a stored script or search template.
* Get a script or search template. Retrieves a stored script or search template.
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-scripting.html | Elasticsearch API documentation}
*/
export default async function GetScriptApi (this: That, params: T.GetScriptRequest | TB.GetScriptRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.GetScriptResponse>

2
src/api/api/get_source.ts
View File

@ -39,7 +39,7 @@ import * as TB from '../typesWithBodyKey'
interface That { transport: Transport }
/**
* Returns the source of a document.
* Get a document's source. Returns the source of a document.
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-get.html | Elasticsearch API documentation}
*/
export default async function GetSourceApi<TDocument = unknown> (this: That, params: T.GetSourceRequest | TB.GetSourceRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.GetSourceResponse<TDocument>>

2
src/api/api/index.ts
View File

@ -39,7 +39,7 @@ import * as TB from '../typesWithBodyKey'
interface That { transport: Transport }
/**
* Adds a JSON document to the specified data stream or index and makes it searchable. If the target is an index and the document already exists, the request updates the document and increments its version.
* Index a document. Adds a JSON document to the specified data stream or index and makes it searchable. If the target is an index and the document already exists, the request updates the document and increments its version.
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-index_.html | Elasticsearch API documentation}
*/
export default async function IndexApi<TDocument = unknown> (this: That, params: T.IndexRequest<TDocument> | TB.IndexRequest<TDocument>, options?: TransportRequestOptionsWithOutMeta): Promise<T.IndexResponse>

38
src/api/api/indices.ts
View File

@ -45,7 +45,7 @@ export default class Indices {
}
/**
* Adds a block to an index.
* Add an index block. Limits the operations allowed on an index by blocking specific operation types.
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/index-modules-blocks.html | Elasticsearch API documentation}
*/
async addBlock (this: That, params: T.IndicesAddBlockRequest | TB.IndicesAddBlockRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.IndicesAddBlockResponse>
@ -247,7 +247,7 @@ export default class Indices {
}
/**
* Creates a new index.
* Create an index. Creates a new index.
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-create-index.html | Elasticsearch API documentation}
*/
async create (this: That, params: T.IndicesCreateRequest | TB.IndicesCreateRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.IndicesCreateResponse>
@ -363,7 +363,7 @@ export default class Indices {
}
/**
* Deletes one or more indices.
* Delete indices. Deletes one or more indices.
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-delete-index.html | Elasticsearch API documentation}
*/
async delete (this: That, params: T.IndicesDeleteRequest | TB.IndicesDeleteRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.IndicesDeleteResponse>
@ -395,7 +395,7 @@ export default class Indices {
}
/**
* Removes a data stream or index from an alias.
* Delete an alias. Removes a data stream or index from an alias.
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html | Elasticsearch API documentation}
*/
async deleteAlias (this: That, params: T.IndicesDeleteAliasRequest | TB.IndicesDeleteAliasRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.IndicesDeleteAliasResponse>
@ -633,7 +633,7 @@ export default class Indices {
}
/**
* Checks if a data stream, index, or alias exists.
* Check indices. Checks if one or more indices, index aliases, or data streams exist.
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-exists.html | Elasticsearch API documentation}
*/
async exists (this: That, params: T.IndicesExistsRequest | TB.IndicesExistsRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.IndicesExistsResponse>
@ -665,7 +665,7 @@ export default class Indices {
}
/**
* Checks if an alias exists.
* Check aliases. Checks if one or more data stream or index aliases exist.
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html | Elasticsearch API documentation}
*/
async existsAlias (this: That, params: T.IndicesExistsAliasRequest | TB.IndicesExistsAliasRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.IndicesExistsAliasResponse>
@ -769,7 +769,7 @@ export default class Indices {
}
/**
* Retrieves information about the index's current data stream lifecycle, such as any potential encountered error, time since creation etc.
* Get the status for a data stream lifecycle. Retrieves information about an index or data stream’s current data stream lifecycle status, such as time since index creation, time since rollover, the lifecycle configuration managing the index, or any errors encountered during lifecycle execution.
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams-explain-lifecycle.html | Elasticsearch API documentation}
*/
async explainDataLifecycle (this: That, params: T.IndicesExplainDataLifecycleRequest | TB.IndicesExplainDataLifecycleRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.IndicesExplainDataLifecycleResponse>
@ -913,7 +913,7 @@ export default class Indices {
}
/**
* Returns information about one or more indices. For data streams, the API returns information about the stream’s backing indices.
* Get index information. Returns information about one or more indices. For data streams, the API returns information about the stream’s backing indices.
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-index.html | Elasticsearch API documentation}
*/
async get (this: That, params: T.IndicesGetRequest | TB.IndicesGetRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.IndicesGetResponse>
@ -945,7 +945,7 @@ export default class Indices {
}
/**
* Retrieves information for one or more aliases.
* Get aliases. Retrieves information for one or more data stream or index aliases.
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html | Elasticsearch API documentation}
*/
async getAlias (this: That, params?: T.IndicesGetAliasRequest | TB.IndicesGetAliasRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.IndicesGetAliasResponse>
@ -1064,7 +1064,7 @@ export default class Indices {
}
/**
* Retrieves mapping definitions for one or more fields. For data streams, the API retrieves field mappings for the stream’s backing indices.
* Get mapping definitions. Retrieves mapping definitions for one or more fields. For data streams, the API retrieves field mappings for the stream’s backing indices.
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-field-mapping.html | Elasticsearch API documentation}
*/
async getFieldMapping (this: That, params: T.IndicesGetFieldMappingRequest | TB.IndicesGetFieldMappingRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.IndicesGetFieldMappingResponse>
@ -1144,7 +1144,7 @@ export default class Indices {
}
/**
* Retrieves mapping definitions for one or more indices. For data streams, the API retrieves mappings for the stream’s backing indices.
* Get mapping definitions. Retrieves mapping definitions for one or more indices. For data streams, the API retrieves mappings for the stream’s backing indices.
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-mapping.html | Elasticsearch API documentation}
*/
async getMapping (this: That, params?: T.IndicesGetMappingRequest | TB.IndicesGetMappingRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.IndicesGetMappingResponse>
@ -1184,7 +1184,7 @@ export default class Indices {
}
/**
* Returns setting information for one or more indices. For data streams, returns setting information for the stream’s backing indices.
* Get index settings. Returns setting information for one or more indices. For data streams, returns setting information for the stream’s backing indices.
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-settings.html | Elasticsearch API documentation}
*/
async getSettings (this: That, params?: T.IndicesGetSettingsRequest | TB.IndicesGetSettingsRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.IndicesGetSettingsResponse>
@ -1408,7 +1408,7 @@ export default class Indices {
}
/**
* Adds a data stream or index to an alias.
* Create or update an alias. Adds a data stream or index to an alias.
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html | Elasticsearch API documentation}
*/
async putAlias (this: That, params: T.IndicesPutAliasRequest | TB.IndicesPutAliasRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.IndicesPutAliasResponse>
@ -1548,7 +1548,7 @@ export default class Indices {
}
/**
* Adds new fields to an existing data stream or index. You can also use this API to change the search settings of existing fields. For data streams, these changes are applied to all backing indices by default.
* Update field mappings. Adds new fields to an existing data stream or index. You can also use this API to change the search settings of existing fields. For data streams, these changes are applied to all backing indices by default.
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-put-mapping.html | Elasticsearch API documentation}
*/
async putMapping (this: That, params: T.IndicesPutMappingRequest | TB.IndicesPutMappingRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.IndicesPutMappingResponse>
@ -1592,7 +1592,7 @@ export default class Indices {
}
/**
* Changes a dynamic index setting in real time. For data streams, index setting changes are applied to all backing indices by default.
* Update index settings. Changes dynamic index settings in real time. For data streams, index setting changes are applied to all backing indices by default.
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-update-settings.html | Elasticsearch API documentation}
*/
async putSettings (this: That, params: T.IndicesPutSettingsRequest | TB.IndicesPutSettingsRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.IndicesPutSettingsResponse>
@ -1720,7 +1720,7 @@ export default class Indices {
}
/**
* A refresh makes recent operations performed on one or more indices available for search. For data streams, the API runs the refresh operation on the stream’s backing indices.
* Refresh an index. A refresh makes recent operations performed on one or more indices available for search. For data streams, the API runs the refresh operation on the stream’s backing indices.
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-refresh.html | Elasticsearch API documentation}
*/
async refresh (this: That, params?: T.IndicesRefreshRequest | TB.IndicesRefreshRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.IndicesRefreshResponse>
@ -1856,7 +1856,7 @@ export default class Indices {
}
/**
* Creates a new index for a data stream or index alias.
* Roll over to a new index. Creates a new index for a data stream or index alias.
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-rollover-index.html | Elasticsearch API documentation}
*/
async rollover (this: That, params: T.IndicesRolloverRequest | TB.IndicesRolloverRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.IndicesRolloverResponse>
@ -2241,7 +2241,7 @@ export default class Indices {
}
/**
* Adds a data stream or index to an alias.
* Create or update an alias. Adds a data stream or index to an alias.
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html | Elasticsearch API documentation}
*/
async updateAliases (this: That, params?: T.IndicesUpdateAliasesRequest | TB.IndicesUpdateAliasesRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.IndicesUpdateAliasesResponse>
@ -2283,7 +2283,7 @@ export default class Indices {
}
/**
* Validates a potentially expensive query without executing it.
* Validate a query. Validates a query without running it.
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/search-validate.html | Elasticsearch API documentation}
*/
async validateQuery (this: That, params?: T.IndicesValidateQueryRequest | TB.IndicesValidateQueryRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.IndicesValidateQueryResponse>

2
src/api/api/info.ts
View File

@ -39,7 +39,7 @@ import * as TB from '../typesWithBodyKey'
interface That { transport: Transport }
/**
* Returns basic information about the cluster.
* Get cluster info. Returns basic information about the cluster.
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/index.html | Elasticsearch API documentation}
*/
export default async function InfoApi (this: That, params?: T.InfoRequest | TB.InfoRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.InfoResponse>

2
src/api/api/license.ts
View File

@ -75,7 +75,7 @@ export default class License {
}
/**
* This API returns information about the type of license, when it was issued, and when it expires, for example. For more information about the different types of licenses, see https://www.elastic.co/subscriptions.
* Get license information. Returns information about your Elastic license, including its type, its status, when it was issued, and when it expires. For more information about the different types of licenses, refer to [Elastic Stack subscriptions](https://www.elastic.co/subscriptions).
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/get-license.html | Elasticsearch API documentation}
*/
async get (this: That, params?: T.LicenseGetRequest | TB.LicenseGetRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.LicenseGetResponse>

2
src/api/api/ping.ts
View File

@ -39,7 +39,7 @@ import * as TB from '../typesWithBodyKey'
interface That { transport: Transport }
/**
* Returns whether the cluster is running.
* Ping the cluster. Returns whether the cluster is running.
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/index.html | Elasticsearch API documentation}
*/
export default async function PingApi (this: That, params?: T.PingRequest | TB.PingRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.PingResponse>

2
src/api/api/put_script.ts
View File

@ -39,7 +39,7 @@ import * as TB from '../typesWithBodyKey'
interface That { transport: Transport }
/**
* Creates or updates a stored script or search template.
* Create or update a script or search template. Creates or updates a stored script or search template.
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-scripting.html | Elasticsearch API documentation}
*/
export default async function PutScriptApi (this: That, params: T.PutScriptRequest | TB.PutScriptRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.PutScriptResponse>

2
src/api/api/reindex.ts
View File

@ -39,7 +39,7 @@ import * as TB from '../typesWithBodyKey'
interface That { transport: Transport }
/**
* Allows to copy documents from one index to another, optionally filtering the source documents by a query, changing the destination index settings, or fetching the documents from a remote cluster.
* Reindex documents. Copies documents from a source to a destination. The source can be any existing index, alias, or data stream. The destination must differ from the source. For example, you cannot reindex a data stream into itself.
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-reindex.html | Elasticsearch API documentation}
*/
export default async function ReindexApi (this: That, params: T.ReindexRequest | TB.ReindexRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.ReindexResponse>

2
src/api/api/scripts_painless_execute.ts
View File

@ -39,7 +39,7 @@ import * as TB from '../typesWithBodyKey'
interface That { transport: Transport }
/**
* Runs a script and returns a result.
* Run a script. Runs a script and returns a result.
* @see {@link https://www.elastic.co/guide/en/elasticsearch/painless/master/painless-execute-api.html | Elasticsearch API documentation}
*/
export default async function ScriptsPainlessExecuteApi<TResult = unknown> (this: That, params?: T.ScriptsPainlessExecuteRequest | TB.ScriptsPainlessExecuteRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.ScriptsPainlessExecuteResponse<TResult>>

2
src/api/api/search_mvt.ts
View File

@ -39,7 +39,7 @@ import * as TB from '../typesWithBodyKey'
interface That { transport: Transport }
/**
* Searches a vector tile for geospatial values. Returns results as a binary Mapbox vector tile.
* Search a vector tile. Searches a vector tile for geospatial values.
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/search-vector-tile-api.html | Elasticsearch API documentation}
*/
export default async function SearchMvtApi (this: That, params: T.SearchMvtRequest | TB.SearchMvtRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SearchMvtResponse>

14
src/api/api/security.ts
View File

@ -86,7 +86,7 @@ export default class Security {
}
/**
* Enables you to submit a request with a basic auth header to authenticate a user and retrieve information about the authenticated user. A successful call returns a JSON structure that shows user information such as their username, the roles that are assigned to the user, any assigned metadata, and information about the realms that authenticated and authorized the user. If the user cannot be authenticated, this API returns a 401 status code.
* Authenticate a user. Authenticates a user and returns information about the authenticated user. Include the user information in a [basic auth header](https://en.wikipedia.org/wiki/Basic_access_authentication). A successful call returns a JSON structure that shows user information such as their username, the roles that are assigned to the user, any assigned metadata, and information about the realms that authenticated and authorized the user. If the user cannot be authenticated, this API returns a 401 status code.
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/security-api-authenticate.html | Elasticsearch API documentation}
*/
async authenticate (this: That, params?: T.SecurityAuthenticateRequest | TB.SecurityAuthenticateRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityAuthenticateResponse>
@ -441,7 +441,7 @@ export default class Security {
}
/**
* Creates an API key for access without requiring basic authentication. A successful request returns a JSON structure that contains the API key, its unique id, and its name. If applicable, it also returns expiration information for the API key in milliseconds. NOTE: By default, API keys never expire. You can specify expiration information when you create the API keys.
* Create an API key. Creates an API key for access without requiring basic authentication. A successful request returns a JSON structure that contains the API key, its unique id, and its name. If applicable, it also returns expiration information for the API key in milliseconds. NOTE: By default, API keys never expire. You can specify expiration information when you create the API keys.
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/security-api-create-api-key.html | Elasticsearch API documentation}
*/
async createApiKey (this: That, params?: T.SecurityCreateApiKeyRequest | TB.SecurityCreateApiKeyRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityCreateApiKeyResponse>
@ -904,7 +904,7 @@ export default class Security {
}
/**
* Retrieves information for one or more API keys. NOTE: If you have only the `manage_own_api_key` privilege, this API returns only the API keys that you own. If you have `read_security`, `manage_api_key` or greater privileges (including `manage_security`), this API returns all API keys regardless of ownership.
* Get API key information. Retrieves information for one or more API keys. NOTE: If you have only the `manage_own_api_key` privilege, this API returns only the API keys that you own. If you have `read_security`, `manage_api_key` or greater privileges (including `manage_security`), this API returns all API keys regardless of ownership.
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/security-api-get-api-key.html | Elasticsearch API documentation}
*/
async getApiKey (this: That, params?: T.SecurityGetApiKeyRequest | TB.SecurityGetApiKeyRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityGetApiKeyResponse>
@ -1379,7 +1379,7 @@ export default class Security {
}
/**
* Determines whether the specified user has a specified list of privileges.
* Check user privileges. Determines whether the specified user has a specified list of privileges.
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/security-api-has-privileges.html | Elasticsearch API documentation}
*/
async hasPrivileges (this: That, params?: T.SecurityHasPrivilegesRequest | TB.SecurityHasPrivilegesRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityHasPrivilegesResponse>
@ -1472,7 +1472,7 @@ export default class Security {
}
/**
* Invalidates one or more API keys. The `manage_api_key` privilege allows deleting any API keys. The `manage_own_api_key` only allows deleting API keys that are owned by the user. In addition, with the `manage_own_api_key` privilege, an invalidation request must be issued in one of the three formats: - Set the parameter `owner=true`. - Or, set both `username` and `realm_name` to match the user’s identity. - Or, if the request is issued by an API key, i.e. an API key invalidates itself, specify its ID in the `ids` field.
* Invalidate API keys. Invalidates one or more API keys. The `manage_api_key` privilege allows deleting any API keys. The `manage_own_api_key` only allows deleting API keys that are owned by the user. In addition, with the `manage_own_api_key` privilege, an invalidation request must be issued in one of the three formats: - Set the parameter `owner=true`. - Or, set both `username` and `realm_name` to match the user’s identity. - Or, if the request is issued by an API key, i.e. an API key invalidates itself, specify its ID in the `ids` field.
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/security-api-invalidate-api-key.html | Elasticsearch API documentation}
*/
async invalidateApiKey (this: That, params?: T.SecurityInvalidateApiKeyRequest | TB.SecurityInvalidateApiKeyRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityInvalidateApiKeyResponse>
@ -1809,7 +1809,7 @@ export default class Security {
}
/**
* Retrieves information for API keys in a paginated manner. You can optionally filter the results with a query.
* Query API keys. Retrieves a paginated list of API keys and their information. You can optionally filter the results with a query.
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/security-api-query-api-key.html | Elasticsearch API documentation}
*/
async queryApiKeys (this: That, params?: T.SecurityQueryApiKeysRequest | TB.SecurityQueryApiKeysRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityQueryApiKeysResponse>
@ -2215,7 +2215,7 @@ export default class Security {
}
/**
* Updates attributes of an existing API key. Users can only update API keys that they created or that were granted to them. Use this API to update API keys created by the create API Key or grant API Key APIs. If you need to apply the same update to many API keys, you can use bulk update API Keys to reduce overhead. It’s not possible to update expired API keys, or API keys that have been invalidated by invalidate API Key. This API supports updates to an API key’s access scope and metadata. The access scope of an API key is derived from the `role_descriptors` you specify in the request, and a snapshot of the owner user’s permissions at the time of the request. The snapshot of the owner’s permissions is updated automatically on every call. If you don’t specify `role_descriptors` in the request, a call to this API might still change the API key’s access scope. This change can occur if the owner user’s permissions have changed since the API key was created or last modified. To update another user’s API key, use the `run_as` feature to submit a request on behalf of another user. IMPORTANT: It’s not possible to use an API key as the authentication credential for this API. To update an API key, the owner user’s credentials are required.
* Update an API key. Updates attributes of an existing API key. Users can only update API keys that they created or that were granted to them. Use this API to update API keys created by the create API Key or grant API Key APIs. If you need to apply the same update to many API keys, you can use bulk update API Keys to reduce overhead. It’s not possible to update expired API keys, or API keys that have been invalidated by invalidate API Key. This API supports updates to an API key’s access scope and metadata. The access scope of an API key is derived from the `role_descriptors` you specify in the request, and a snapshot of the owner user’s permissions at the time of the request. The snapshot of the owner’s permissions is updated automatically on every call. If you don’t specify `role_descriptors` in the request, a call to this API might still change the API key’s access scope. This change can occur if the owner user’s permissions have changed since the API key was created or last modified. To update another user’s API key, use the `run_as` feature to submit a request on behalf of another user. IMPORTANT: It’s not possible to use an API key as the authentication credential for this API. To update an API key, the owner user’s credentials are required.
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/security-api-update-api-key.html | Elasticsearch API documentation}
*/
async updateApiKey (this: That, params: T.SecurityUpdateApiKeyRequest | TB.SecurityUpdateApiKeyRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityUpdateApiKeyResponse>

2
src/api/api/tasks.ts
View File

@ -85,7 +85,7 @@ export default class Tasks {
}
/**
* Returns information about a task.
* Get task information. Returns information about the tasks currently executing in the cluster.
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/tasks.html | Elasticsearch API documentation}
*/
async get (this: That, params: T.TasksGetRequest | TB.TasksGetRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.TasksGetResponse>

2
src/api/api/termvectors.ts
View File

@ -39,7 +39,7 @@ import * as TB from '../typesWithBodyKey'
interface That { transport: Transport }
/**
* Returns information and statistics about terms in the fields of a particular document.
* Get term vector information. Returns information and statistics about terms in the fields of a particular document.
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-termvectors.html | Elasticsearch API documentation}
*/
export default async function TermvectorsApi<TDocument = unknown> (this: That, params: T.TermvectorsRequest<TDocument> | TB.TermvectorsRequest<TDocument>, options?: TransportRequestOptionsWithOutMeta): Promise<T.TermvectorsResponse>

20
src/api/api/transform.ts
View File

@ -45,7 +45,7 @@ export default class Transform {
}
/**
* Deletes a transform.
* Delete a transform. Deletes a transform.
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/delete-transform.html | Elasticsearch API documentation}
*/
async deleteTransform (this: That, params: T.TransformDeleteTransformRequest | TB.TransformDeleteTransformRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.TransformDeleteTransformResponse>
@ -106,7 +106,7 @@ export default class Transform {
}
/**
* Retrieves configuration information for transforms.
* Get transforms. Retrieves configuration information for transforms.
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/get-transform.html | Elasticsearch API documentation}
*/
async getTransform (this: That, params?: T.TransformGetTransformRequest | TB.TransformGetTransformRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.TransformGetTransformResponse>
@ -146,7 +146,7 @@ export default class Transform {
}
/**
* Retrieves usage information for transforms.
* Get transform stats. Retrieves usage information for transforms.
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/get-transform-stats.html | Elasticsearch API documentation}
*/
async getTransformStats (this: That, params: T.TransformGetTransformStatsRequest | TB.TransformGetTransformStatsRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.TransformGetTransformStatsResponse>
@ -178,7 +178,7 @@ export default class Transform {
}
/**
* Previews a transform. It returns a maximum of 100 results. The calculations are based on all the current data in the source index. It also generates a list of mappings and settings for the destination index. These values are determined based on the field types of the source index and the transform aggregations.
* Preview a transform. Generates a preview of the results that you will get when you create a transform with the same configuration. It returns a maximum of 100 results. The calculations are based on all the current data in the source index. It also generates a list of mappings and settings for the destination index. These values are determined based on the field types of the source index and the transform aggregations.
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/preview-transform.html | Elasticsearch API documentation}
*/
async previewTransform<TTransform = unknown> (this: That, params?: T.TransformPreviewTransformRequest | TB.TransformPreviewTransformRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.TransformPreviewTransformResponse<TTransform>>
@ -230,7 +230,7 @@ export default class Transform {
}
/**
* Creates a transform. A transform copies data from source indices, transforms it, and persists it into an entity-centric destination index. You can also think of the destination index as a two-dimensional tabular data structure (known as a data frame). The ID for each document in the data frame is generated from a hash of the entity, so there is a unique row per entity. You must choose either the latest or pivot method for your transform; you cannot use both in a single transform. If you choose to use the pivot method for your transform, the entities are defined by the set of `group_by` fields in the pivot object. If you choose to use the latest method, the entities are defined by the `unique_key` field values in the latest object. You must have `create_index`, `index`, and `read` privileges on the destination index and `read` and `view_index_metadata` privileges on the source indices. When Elasticsearch security features are enabled, the transform remembers which roles the user that created it had at the time of creation and uses those same roles. If those roles do not have the required privileges on the source and destination indices, the transform fails when it attempts unauthorized operations. NOTE: You must use Kibana or this API to create a transform. Do not add a transform directly into any `.transform-internal*` indices using the Elasticsearch index API. If Elasticsearch security features are enabled, do not give users any privileges on `.transform-internal*` indices. If you used transforms prior to 7.5, also do not give users any privileges on `.data-frame-internal*` indices.
* Create a transform. Creates a transform. A transform copies data from source indices, transforms it, and persists it into an entity-centric destination index. You can also think of the destination index as a two-dimensional tabular data structure (known as a data frame). The ID for each document in the data frame is generated from a hash of the entity, so there is a unique row per entity. You must choose either the latest or pivot method for your transform; you cannot use both in a single transform. If you choose to use the pivot method for your transform, the entities are defined by the set of `group_by` fields in the pivot object. If you choose to use the latest method, the entities are defined by the `unique_key` field values in the latest object. You must have `create_index`, `index`, and `read` privileges on the destination index and `read` and `view_index_metadata` privileges on the source indices. When Elasticsearch security features are enabled, the transform remembers which roles the user that created it had at the time of creation and uses those same roles. If those roles do not have the required privileges on the source and destination indices, the transform fails when it attempts unauthorized operations. NOTE: You must use Kibana or this API to create a transform. Do not add a transform directly into any `.transform-internal*` indices using the Elasticsearch index API. If Elasticsearch security features are enabled, do not give users any privileges on `.transform-internal*` indices. If you used transforms prior to 7.5, also do not give users any privileges on `.data-frame-internal*` indices.
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/put-transform.html | Elasticsearch API documentation}
*/
async putTransform (this: That, params: T.TransformPutTransformRequest | TB.TransformPutTransformRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.TransformPutTransformResponse>
@ -274,7 +274,7 @@ export default class Transform {
}
/**
* Resets a transform. Before you can reset it, you must stop it; alternatively, use the `force` query parameter. If the destination index was created by the transform, it is deleted.
* Reset a transform. Resets a transform. Before you can reset it, you must stop it; alternatively, use the `force` query parameter. If the destination index was created by the transform, it is deleted.
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/reset-transform.html | Elasticsearch API documentation}
*/
async resetTransform (this: That, params: T.TransformResetTransformRequest | TB.TransformResetTransformRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.TransformResetTransformResponse>
@ -306,7 +306,7 @@ export default class Transform {
}
/**
* Schedules now a transform. If you _schedule_now a transform, it will process the new data instantly, without waiting for the configured frequency interval. After _schedule_now API is called, the transform will be processed again at now + frequency unless _schedule_now API is called again in the meantime.
* Schedule a transform to start now. Instantly runs a transform to process data. If you _schedule_now a transform, it will process the new data instantly, without waiting for the configured frequency interval. After _schedule_now API is called, the transform will be processed again at now + frequency unless _schedule_now API is called again in the meantime.
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/schedule-now-transform.html | Elasticsearch API documentation}
*/
async scheduleNowTransform (this: That, params: T.TransformScheduleNowTransformRequest | TB.TransformScheduleNowTransformRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.TransformScheduleNowTransformResponse>
@ -338,7 +338,7 @@ export default class Transform {
}
/**
* Starts a transform. When you start a transform, it creates the destination index if it does not already exist. The `number_of_shards` is set to `1` and the `auto_expand_replicas` is set to `0-1`. If it is a pivot transform, it deduces the mapping definitions for the destination index from the source indices and the transform aggregations. If fields in the destination index are derived from scripts (as in the case of `scripted_metric` or `bucket_script` aggregations), the transform uses dynamic mappings unless an index template exists. If it is a latest transform, it does not deduce mapping definitions; it uses dynamic mappings. To use explicit mappings, create the destination index before you start the transform. Alternatively, you can create an index template, though it does not affect the deduced mappings in a pivot transform. When the transform starts, a series of validations occur to ensure its success. If you deferred validation when you created the transform, they occur when you start the transform—with the exception of privilege checks. When Elasticsearch security features are enabled, the transform remembers which roles the user that created it had at the time of creation and uses those same roles. If those roles do not have the required privileges on the source and destination indices, the transform fails when it attempts unauthorized operations.
* Start a transform. Starts a transform. When you start a transform, it creates the destination index if it does not already exist. The `number_of_shards` is set to `1` and the `auto_expand_replicas` is set to `0-1`. If it is a pivot transform, it deduces the mapping definitions for the destination index from the source indices and the transform aggregations. If fields in the destination index are derived from scripts (as in the case of `scripted_metric` or `bucket_script` aggregations), the transform uses dynamic mappings unless an index template exists. If it is a latest transform, it does not deduce mapping definitions; it uses dynamic mappings. To use explicit mappings, create the destination index before you start the transform. Alternatively, you can create an index template, though it does not affect the deduced mappings in a pivot transform. When the transform starts, a series of validations occur to ensure its success. If you deferred validation when you created the transform, they occur when you start the transform—with the exception of privilege checks. When Elasticsearch security features are enabled, the transform remembers which roles the user that created it had at the time of creation and uses those same roles. If those roles do not have the required privileges on the source and destination indices, the transform fails when it attempts unauthorized operations.
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/start-transform.html | Elasticsearch API documentation}
*/
async startTransform (this: That, params: T.TransformStartTransformRequest | TB.TransformStartTransformRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.TransformStartTransformResponse>
@ -370,7 +370,7 @@ export default class Transform {
}
/**
* Stops one or more transforms.
* Stop transforms. Stops one or more transforms.
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/stop-transform.html | Elasticsearch API documentation}
*/
async stopTransform (this: That, params: T.TransformStopTransformRequest | TB.TransformStopTransformRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.TransformStopTransformResponse>
@ -402,7 +402,7 @@ export default class Transform {
}
/**
* Updates certain properties of a transform. All updated properties except `description` do not take effect until after the transform starts the next checkpoint, thus there is data consistency in each checkpoint. To use this API, you must have `read` and `view_index_metadata` privileges for the source indices. You must also have `index` and `read` privileges for the destination index. When Elasticsearch security features are enabled, the transform remembers which roles the user who updated it had at the time of update and runs with those privileges.
* Update a transform. Updates certain properties of a transform. All updated properties except `description` do not take effect until after the transform starts the next checkpoint, thus there is data consistency in each checkpoint. To use this API, you must have `read` and `view_index_metadata` privileges for the source indices. You must also have `index` and `read` privileges for the destination index. When Elasticsearch security features are enabled, the transform remembers which roles the user who updated it had at the time of update and runs with those privileges.
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/update-transform.html | Elasticsearch API documentation}
*/
async updateTransform (this: That, params: T.TransformUpdateTransformRequest | TB.TransformUpdateTransformRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.TransformUpdateTransformResponse>

2
src/api/api/update.ts
View File

@ -39,7 +39,7 @@ import * as TB from '../typesWithBodyKey'
interface That { transport: Transport }
/**
* Updates a document with a script or partial document.
* Update a document. Updates a document by running a script or passing a partial document.
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-update.html | Elasticsearch API documentation}
*/
export default async function UpdateApi<TDocument = unknown, TPartialDocument = unknown, TDocumentR = unknown> (this: That, params: T.UpdateRequest<TDocument, TPartialDocument> | TB.UpdateRequest<TDocument, TPartialDocument>, options?: TransportRequestOptionsWithOutMeta): Promise<T.UpdateResponse<TDocumentR>>

2
src/api/api/update_by_query.ts
View File

@ -39,7 +39,7 @@ import * as TB from '../typesWithBodyKey'
interface That { transport: Transport }
/**
* Updates documents that match the specified query. If no query is specified, performs an update on every document in the data stream or index without modifying the source, which is useful for picking up mapping changes.
* Update documents. Updates documents that match the specified query. If no query is specified, performs an update on every document in the data stream or index without modifying the source, which is useful for picking up mapping changes.
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-update-by-query.html | Elasticsearch API documentation}
*/
export default async function UpdateByQueryApi (this: That, params: T.UpdateByQueryRequest | TB.UpdateByQueryRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.UpdateByQueryResponse>

51
src/api/types.ts
View File

@ -9082,14 +9082,15 @@ export interface ClusterStatsStatsResponseBase extends NodesNodesResponseBase {
export interface ConnectorConnector {
api_key_id?: string
api_key_secret_id?: string
configuration: ConnectorConnectorConfiguration
custom_scheduling: ConnectorConnectorCustomScheduling
description?: string
error?: string
error?: string | null
features?: ConnectorConnectorFeatures
filtering: ConnectorFilteringConfig[]
id?: Id
index_name?: IndexName
index_name?: IndexName | null
is_native: boolean
language?: string
last_access_control_sync_error?: string
@ -9106,8 +9107,9 @@ export interface ConnectorConnector {
name?: string
pipeline?: ConnectorIngestPipelineParams
scheduling: ConnectorSchedulingConfiguration
service_type: string
service_type?: string
status: ConnectorConnectorStatus
sync_cursor?: any
sync_now: boolean
}
@ -9122,11 +9124,11 @@ export interface ConnectorConnectorConfigProperties {
placeholder?: string
required: boolean
sensitive: boolean
tooltip?: string
tooltip?: string | null
type: ConnectorConnectorFieldType
ui_restrictions: string[]
validations: ConnectorValidation[]
value: ScalarValue
value: any
}
export type ConnectorConnectorConfiguration = Record<string, ConnectorConnectorConfigProperties>
@ -9135,9 +9137,8 @@ export type ConnectorConnectorCustomScheduling = Record<string, ConnectorCustomS
export interface ConnectorConnectorFeatures {
document_level_security?: ConnectorFeatureEnabled
filtering_advanced_config?: boolean
filtering_rules?: boolean
incremental_sync?: ConnectorFeatureEnabled
native_connector_api_keys?: ConnectorFeatureEnabled
sync_rules?: ConnectorSyncRulesFeature
}
@ -9206,7 +9207,7 @@ export interface ConnectorFilteringAdvancedSnippet {
export interface ConnectorFilteringConfig {
active: ConnectorFilteringRules
domain: string
domain?: string
draft: ConnectorFilteringRules
}
@ -9250,7 +9251,7 @@ export interface ConnectorGreaterThanValidation {
export interface ConnectorIncludedInValidation {
type: 'included_in'
constraint: string
constraint: ScalarValue[]
}
export interface ConnectorIngestPipelineParams {
@ -9267,7 +9268,7 @@ export interface ConnectorLessThanValidation {
export interface ConnectorListTypeValidation {
type: 'list_type'
constraint: ScalarValue[]
constraint: string
}
export interface ConnectorRegexValidation {
@ -9283,7 +9284,7 @@ export interface ConnectorSchedulingConfiguration {
export interface ConnectorSelectOption {
label: string
value: string
value: ScalarValue
}
export interface ConnectorSyncJobConnectorReference {
@ -9294,6 +9295,7 @@ export interface ConnectorSyncJobConnectorReference {
language?: string
pipeline?: ConnectorIngestPipelineParams
service_type: string
sync_cursor?: any
}
export type ConnectorSyncJobTriggerMethod = 'on_demand' | 'scheduled'
@ -9319,7 +9321,7 @@ export interface ConnectorCheckInResponse {
export interface ConnectorDeleteRequest extends RequestBase {
connector_id: Id
delete_sync_jobs: boolean
delete_sync_jobs?: boolean
}
export type ConnectorDeleteResponse = AcknowledgedResponseBase
@ -9332,17 +9334,18 @@ export type ConnectorGetResponse = ConnectorConnector
export interface ConnectorLastSyncRequest extends RequestBase {
connector_id: Id
last_access_control_sync_error?: SpecUtilsWithNullValue<string>
last_access_control_sync_error?: string
last_access_control_sync_scheduled_at?: DateTime
last_access_control_sync_status?: ConnectorSyncStatus
last_deleted_document_count?: long
last_incremental_sync_scheduled_at?: DateTime
last_indexed_document_count?: long
last_seen?: SpecUtilsWithNullValue<DateTime>
last_sync_error?: SpecUtilsWithNullValue<string>
last_seen?: DateTime
last_sync_error?: string
last_sync_scheduled_at?: DateTime
last_sync_status?: ConnectorSyncStatus
last_synced?: DateTime
sync_cursor?: any
}
export interface ConnectorLastSyncResponse {
@ -9365,7 +9368,7 @@ export interface ConnectorListResponse {
export interface ConnectorPostRequest extends RequestBase {
description?: string
index_name: SpecUtilsWithNullValue<IndexName>
index_name?: IndexName
is_native?: boolean
language?: string
name?: string
@ -9373,13 +9376,14 @@ export interface ConnectorPostRequest extends RequestBase {
}
export interface ConnectorPostResponse {
result: Result
id: Id
}
export interface ConnectorPutRequest extends RequestBase {
connector_id: Id
connector_id?: Id
description?: string
index_name: SpecUtilsWithNullValue<IndexName>
index_name?: IndexName
is_native?: boolean
language?: string
name?: string
@ -9388,6 +9392,7 @@ export interface ConnectorPutRequest extends RequestBase {
export interface ConnectorPutResponse {
result: Result
id: Id
}
export interface ConnectorSyncJobCancelRequest extends RequestBase {
@ -9415,7 +9420,7 @@ export interface ConnectorSyncJobListRequest extends RequestBase {
size?: integer
status?: ConnectorSyncStatus
connector_id?: Id
job_type?: ConnectorSyncJobType[]
job_type?: ConnectorSyncJobType | ConnectorSyncJobType[]
}
export interface ConnectorSyncJobListResponse {
@ -9443,8 +9448,8 @@ export interface ConnectorUpdateActiveFilteringResponse {
export interface ConnectorUpdateApiKeyIdRequest extends RequestBase {
connector_id: Id
api_key_id?: SpecUtilsWithNullValue<string>
api_key_secret_id?: SpecUtilsWithNullValue<string>
api_key_id?: string
api_key_secret_id?: string
}
export interface ConnectorUpdateApiKeyIdResponse {
@ -9501,7 +9506,7 @@ export interface ConnectorUpdateIndexNameResponse {
export interface ConnectorUpdateNameRequest extends RequestBase {
connector_id: Id
name: string
name?: string
description?: string
}
@ -13868,7 +13873,7 @@ export interface MlTrainedModelPrefixStrings {
export interface MlTrainedModelSizeStats {
model_size_bytes: ByteSize
required_native_memory_bytes: integer
required_native_memory_bytes: ByteSize
}
export interface MlTrainedModelStats {

51
src/api/typesWithBodyKey.ts
View File

@ -9183,14 +9183,15 @@ export interface ClusterStatsStatsResponseBase extends NodesNodesResponseBase {
export interface ConnectorConnector {
api_key_id?: string
api_key_secret_id?: string
configuration: ConnectorConnectorConfiguration
custom_scheduling: ConnectorConnectorCustomScheduling
description?: string
error?: string
error?: string | null
features?: ConnectorConnectorFeatures
filtering: ConnectorFilteringConfig[]
id?: Id
index_name?: IndexName
index_name?: IndexName | null
is_native: boolean
language?: string
last_access_control_sync_error?: string
@ -9207,8 +9208,9 @@ export interface ConnectorConnector {
name?: string
pipeline?: ConnectorIngestPipelineParams
scheduling: ConnectorSchedulingConfiguration
service_type: string
service_type?: string
status: ConnectorConnectorStatus
sync_cursor?: any
sync_now: boolean
}
@ -9223,11 +9225,11 @@ export interface ConnectorConnectorConfigProperties {
placeholder?: string
required: boolean
sensitive: boolean
tooltip?: string
tooltip?: string | null
type: ConnectorConnectorFieldType
ui_restrictions: string[]
validations: ConnectorValidation[]
value: ScalarValue
value: any
}
export type ConnectorConnectorConfiguration = Record<string, ConnectorConnectorConfigProperties>
@ -9236,9 +9238,8 @@ export type ConnectorConnectorCustomScheduling = Record<string, ConnectorCustomS
export interface ConnectorConnectorFeatures {
document_level_security?: ConnectorFeatureEnabled
filtering_advanced_config?: boolean
filtering_rules?: boolean
incremental_sync?: ConnectorFeatureEnabled
native_connector_api_keys?: ConnectorFeatureEnabled
sync_rules?: ConnectorSyncRulesFeature
}
@ -9307,7 +9308,7 @@ export interface ConnectorFilteringAdvancedSnippet {
export interface ConnectorFilteringConfig {
active: ConnectorFilteringRules
domain: string
domain?: string
draft: ConnectorFilteringRules
}
@ -9351,7 +9352,7 @@ export interface ConnectorGreaterThanValidation {
export interface ConnectorIncludedInValidation {
type: 'included_in'
constraint: string
constraint: ScalarValue[]
}
export interface ConnectorIngestPipelineParams {
@ -9368,7 +9369,7 @@ export interface ConnectorLessThanValidation {
export interface ConnectorListTypeValidation {
type: 'list_type'
constraint: ScalarValue[]
constraint: string
}
export interface ConnectorRegexValidation {
@ -9384,7 +9385,7 @@ export interface ConnectorSchedulingConfiguration {
export interface ConnectorSelectOption {
label: string
value: string
value: ScalarValue
}
export interface ConnectorSyncJobConnectorReference {
@ -9395,6 +9396,7 @@ export interface ConnectorSyncJobConnectorReference {
language?: string
pipeline?: ConnectorIngestPipelineParams
service_type: string
sync_cursor?: any
}
export type ConnectorSyncJobTriggerMethod = 'on_demand' | 'scheduled'
@ -9420,7 +9422,7 @@ export interface ConnectorCheckInResponse {
export interface ConnectorDeleteRequest extends RequestBase {
connector_id: Id
delete_sync_jobs: boolean
delete_sync_jobs?: boolean
}
export type ConnectorDeleteResponse = AcknowledgedResponseBase
@ -9435,17 +9437,18 @@ export interface ConnectorLastSyncRequest extends RequestBase {
connector_id: Id
/** @deprecated The use of the 'body' key has been deprecated, move the nested keys to the top level object. */
body?: {
last_access_control_sync_error?: SpecUtilsWithNullValue<string>
last_access_control_sync_error?: string
last_access_control_sync_scheduled_at?: DateTime
last_access_control_sync_status?: ConnectorSyncStatus
last_deleted_document_count?: long
last_incremental_sync_scheduled_at?: DateTime
last_indexed_document_count?: long
last_seen?: SpecUtilsWithNullValue<DateTime>
last_sync_error?: SpecUtilsWithNullValue<string>
last_seen?: DateTime
last_sync_error?: string
last_sync_scheduled_at?: DateTime
last_sync_status?: ConnectorSyncStatus
last_synced?: DateTime
sync_cursor?: any
}
}
@ -9471,7 +9474,7 @@ export interface ConnectorPostRequest extends RequestBase {
/** @deprecated The use of the 'body' key has been deprecated, move the nested keys to the top level object. */
body?: {
description?: string
index_name: SpecUtilsWithNullValue<IndexName>
index_name?: IndexName
is_native?: boolean
language?: string
name?: string
@ -9480,15 +9483,16 @@ export interface ConnectorPostRequest extends RequestBase {
}
export interface ConnectorPostResponse {
result: Result
id: Id
}
export interface ConnectorPutRequest extends RequestBase {
connector_id: Id
connector_id?: Id
/** @deprecated The use of the 'body' key has been deprecated, move the nested keys to the top level object. */
body?: {
description?: string
index_name: SpecUtilsWithNullValue<IndexName>
index_name?: IndexName
is_native?: boolean
language?: string
name?: string
@ -9498,6 +9502,7 @@ export interface ConnectorPutRequest extends RequestBase {
export interface ConnectorPutResponse {
result: Result
id: Id
}
export interface ConnectorSyncJobCancelRequest extends RequestBase {
@ -9525,7 +9530,7 @@ export interface ConnectorSyncJobListRequest extends RequestBase {
size?: integer
status?: ConnectorSyncStatus
connector_id?: Id
job_type?: ConnectorSyncJobType[]
job_type?: ConnectorSyncJobType | ConnectorSyncJobType[]
}
export interface ConnectorSyncJobListResponse {
@ -9558,8 +9563,8 @@ export interface ConnectorUpdateApiKeyIdRequest extends RequestBase {
connector_id: Id
/** @deprecated The use of the 'body' key has been deprecated, move the nested keys to the top level object. */
body?: {
api_key_id?: SpecUtilsWithNullValue<string>
api_key_secret_id?: SpecUtilsWithNullValue<string>
api_key_id?: string
api_key_secret_id?: string
}
}
@ -9634,7 +9639,7 @@ export interface ConnectorUpdateNameRequest extends RequestBase {
connector_id: Id
/** @deprecated The use of the 'body' key has been deprecated, move the nested keys to the top level object. */
body?: {
name: string
name?: string
description?: string
}
}
@ -14103,7 +14108,7 @@ export interface MlTrainedModelPrefixStrings {
export interface MlTrainedModelSizeStats {
model_size_bytes: ByteSize
required_native_memory_bytes: integer
required_native_memory_bytes: ByteSize
}
export interface MlTrainedModelStats {