@elastic/elasticsearch 9.3.1 → 9.3.2

package/esm/api/types.d.ts

@@ -26,8 +26,8 @@ export interface BulkOperationBase {
     _id?: Id;
     /** The name of the index or index alias to perform the action on. */
     _index?: IndexName;
-    /** A custom value used to route operations to a specific shard. */
-    routing?: Routing;
+    /** A custom value used to route operations to a specific shard, or multiple comma separated values. */
+    routing?: string;
     if_primary_term?: long;
     if_seq_no?: SequenceNumber;
     version?: VersionNumber;
@@ -2426,7 +2426,7 @@ export interface ReindexDestination {
       * If it is `keep`, the routing on the bulk request sent for each match is set to the routing on the match.
       * If it is `discard`, the routing on the bulk request sent for each match is set to `null`.
       * If it is `=value`, the routing on the bulk request sent for each match is set to all value specified after the equals sign (`=`). */
-    routing?: Routing;
+    routing?: string;
     /** The versioning to use for the indexing operation. */
     version_type?: VersionType;
 }
@@ -3253,7 +3253,7 @@ export interface SearchCompletionSuggestOption<TDocument = unknown> {
     fields?: Record<string, any>;
     _id?: string;
     _index?: IndexName;
-    _routing?: Routing;
+    _routing?: string;
     _score?: double;
     _source?: TDocument;
     text: string;
@@ -7128,13 +7128,20 @@ export interface AggregationsMultiBucketAggregateBase<TBucket = unknown> extends
 export interface AggregationsMultiBucketBase {
     doc_count: long;
 }
-export interface AggregationsMultiTermLookup {
-    /** A fields from which to retrieve terms. */
-    field: Field;
+interface AggregationsMultiTermLookupCommonProps {
     /** The value to apply to documents that do not have a value.
       * By default, documents without a value are ignored. */
     missing?: AggregationsMissing;
 }
+interface AggregationsMultiTermLookupExclusiveProps {
+    /** A field from which to retrieve terms.
+      * It is required if `script` is not provided. */
+    field?: Field;
+    /** A script to calculate terms to aggregate on.
+      * It is required if `field` is not provided. */
+    script?: Script | ScriptSource;
+}
+export type AggregationsMultiTermLookup = AggregationsMultiTermLookupCommonProps & ExactlyOne<AggregationsMultiTermLookupExclusiveProps>;
 export interface AggregationsMultiTermsAggregate extends AggregationsTermsAggregateBase<AggregationsMultiTermsBucket> {
 }
 export interface AggregationsMultiTermsAggregation extends AggregationsBucketAggregationBase {
@@ -9570,7 +9577,7 @@ export interface QueryDslFieldLookup {
     /** Name of the field. */
     path?: Field;
     /** Custom routing value. */
-    routing?: Routing;
+    routing?: string;
 }
 export type QueryDslFieldValueFactorModifier = 'none' | 'log' | 'log1p' | 'log2p' | 'ln' | 'ln1p' | 'ln2p' | 'square' | 'sqrt' | 'reciprocal';
 export interface QueryDslFieldValueFactorScoreFunction {
@@ -10016,7 +10023,7 @@ export interface QueryDslMoreLikeThisQuery extends QueryDslQueryBase {
     min_term_freq?: integer;
     /** The minimum word length below which the terms are ignored. */
     min_word_length?: integer;
-    routing?: Routing;
+    routing?: string;
     /** An array of stop words.
       * Any word in this set is ignored. */
     stop_words?: AnalysisStopWords;
@@ -10107,7 +10114,7 @@ export interface QueryDslPercolateQuery extends QueryDslQueryBase {
     /** Preference used to fetch document to percolate. */
     preference?: string;
     /** Routing used to fetch document to percolate. */
-    routing?: Routing;
+    routing?: string;
     /** The expected version of a stored document to percolate. */
     version?: VersionNumber;
 }
@@ -10603,7 +10610,7 @@ export interface QueryDslTermsLookup {
     index: IndexName;
     id: Id;
     path: Field;
-    routing?: Routing;
+    routing?: string;
 }
 export interface QueryDslTermsQueryKeys extends QueryDslQueryBase {
 }
@@ -20271,6 +20278,15 @@ export interface EsqlAsyncQueryRequest extends RequestBase {
     /** Indicates whether the query and its results are stored in the cluster.
       * If false, the query and its results are stored in the cluster only if the request does not complete during the period set by the `wait_for_completion_timeout` parameter. */
     keep_on_completion?: boolean;
+    /** Specifies a subset of projects to target using project
+      * metadata tags in a subset of Lucene query syntax.
+      * Allowed Lucene queries: the _alias tag and a single value (possibly wildcarded).
+      * Examples:
+      *  _alias:my-project
+      *  _alias:_origin
+      *  _alias:*pr*
+      * Supported in serverless only. */
+    project_routing?: ProjectRouting;
     /** All values in `body` will be added to the request body. */
     body?: string | ({
         [key: string]: any;
@@ -20291,6 +20307,7 @@ export interface EsqlAsyncQueryRequest extends RequestBase {
         wait_for_completion_timeout?: never;
         keep_alive?: never;
         keep_on_completion?: never;
+        project_routing?: never;
     });
     /** All values in `querystring` will be added to the request querystring. */
     querystring?: {
@@ -20312,6 +20329,7 @@ export interface EsqlAsyncQueryRequest extends RequestBase {
         wait_for_completion_timeout?: never;
         keep_alive?: never;
         keep_on_completion?: never;
+        project_routing?: never;
     };
 }
 export type EsqlAsyncQueryResponse = EsqlAsyncEsqlResult;
@@ -20541,6 +20559,15 @@ export interface EsqlQueryRequest extends RequestBase {
       * count.
       * This is similar to `include_ccs_metadata`, but it also returns metadata when the query is not CCS/CPS */
     include_execution_metadata?: boolean;
+    /** Specifies a subset of projects to target using project
+      * metadata tags in a subset of Lucene query syntax.
+      * Allowed Lucene queries: the _alias tag and a single value (possibly wildcarded).
+      * Examples:
+      *  _alias:my-project
+      *  _alias:_origin
+      *  _alias:*pr*
+      * Supported in serverless only. */
+    project_routing?: ProjectRouting;
     /** All values in `body` will be added to the request body. */
     body?: string | ({
         [key: string]: any;
@@ -20558,6 +20585,7 @@ export interface EsqlQueryRequest extends RequestBase {
         tables?: never;
         include_ccs_metadata?: never;
         include_execution_metadata?: never;
+        project_routing?: never;
     });
     /** All values in `querystring` will be added to the request querystring. */
     querystring?: {
@@ -20576,6 +20604,7 @@ export interface EsqlQueryRequest extends RequestBase {
         tables?: never;
         include_ccs_metadata?: never;
         include_execution_metadata?: never;
+        project_routing?: never;
     };
 }
 export type EsqlQueryResponse = EsqlEsqlResult;
@@ -21598,17 +21627,17 @@ export interface IndicesAlias {
     filter?: QueryDslQueryContainer;
     /** Value used to route indexing operations to a specific shard.
       * If specified, this overwrites the `routing` value for indexing operations. */
-    index_routing?: Routing;
+    index_routing?: string;
     /** If `true`, the alias is hidden.
       * All indices for the alias must have the same `is_hidden` value. */
     is_hidden?: boolean;
     /** If `true`, the index is the write index for the alias. */
     is_write_index?: boolean;
     /** Value used to route indexing and search operations to a specific shard. */
-    routing?: Routing;
+    routing?: string;
     /** Value used to route search operations to a specific shard.
       * If specified, this overwrites the `routing` value for search operations. */
-    search_routing?: Routing;
+    search_routing?: string;
 }
 export interface IndicesAliasDefinition {
     /** Query used to limit documents the alias can access. */
@@ -24321,7 +24350,7 @@ export interface IndicesPutAliasRequest extends RequestBase {
     /** Value used to route indexing operations to a specific shard.
       * If specified, this overwrites the `routing` value for indexing operations.
       * Data stream aliases don’t support this parameter. */
-    index_routing?: Routing;
+    index_routing?: string;
     /** If `true`, sets the write index or data stream for the alias.
       * If an alias points to multiple indices or data streams and `is_write_index` isn’t set, the alias rejects write requests.
       * If an index alias points to one index and `is_write_index` isn’t set, the index automatically acts as the write index.
@@ -24329,11 +24358,11 @@ export interface IndicesPutAliasRequest extends RequestBase {
     is_write_index?: boolean;
     /** Value used to route indexing and search operations to a specific shard.
       * Data stream aliases don’t support this parameter. */
-    routing?: Routing;
+    routing?: string;
     /** Value used to route search operations to a specific shard.
       * If specified, this overwrites the `routing` value for search operations.
       * Data stream aliases don’t support this parameter. */
-    search_routing?: Routing;
+    search_routing?: string;
     /** All values in `body` will be added to the request body. */
     body?: string | ({
         [key: string]: any;
@@ -26055,18 +26084,18 @@ export interface IndicesUpdateAliasesAddAction {
     /** Value used to route indexing operations to a specific shard.
       * If specified, this overwrites the `routing` value for indexing operations.
       * Data stream aliases don’t support this parameter. */
-    index_routing?: Routing;
+    index_routing?: string;
     /** If `true`, the alias is hidden. */
     is_hidden?: boolean;
     /** If `true`, sets the write index or data stream for the alias. */
     is_write_index?: boolean;
     /** Value used to route indexing and search operations to a specific shard.
       * Data stream aliases don’t support this parameter. */
-    routing?: Routing;
+    routing?: string;
     /** Value used to route search operations to a specific shard.
       * If specified, this overwrites the `routing` value for search operations.
       * Data stream aliases don’t support this parameter. */
-    search_routing?: Routing;
+    search_routing?: string;
     /** If `true`, the alias must exist to perform the action. */
     must_exist?: boolean;
 }
@@ -27845,9 +27874,10 @@ export interface InferenceDeleteRequest extends RequestBase {
 }
 export type InferenceDeleteResponse = InferenceDeleteInferenceEndpointResult;
 export interface InferenceGetRequest extends RequestBase {
-    /** The task type */
+    /** The task type of the endpoint to return */
     task_type?: InferenceTaskType;
-    /** The inference Id */
+    /** The inference Id of the endpoint to return. Using `_all` or `*` will return all endpoints with the specified
+      * `task_type` if one is specified, or all endpoints for all task types if no `task_type` is specified */
     inference_id?: Id;
     /** All values in `body` will be added to the request body. */
     body?: string | ({
@@ -37569,9 +37599,14 @@ export interface NodesStatsResponseBase extends NodesNodesResponseBase {
     nodes: Record<string, NodesStats>;
 }
 export interface NodesUsageNodeUsage {
+    /** The total number of times each REST endpoint has been called on this node since the last restart.
+      *  Note that the REST endpoint names are not considered stable. */
     rest_actions: Record<string, integer>;
+    /** The timestamp for when the collection of these statistics started. */
     since: EpochTime<UnitMillis>;
+    /** The timestamp for when these statistics were collected. */
     timestamp: EpochTime<UnitMillis>;
+    /** The total number of times search aggregations have been called on this node since the last restart. */
     aggregations: Record<string, any>;
 }
 export type NodesUsageNodesUsageMetric = '_all' | 'rest_actions' | 'aggregations';