/* * Copyright OpenSearch Contributors * SPDX-License-Identifier: Apache-2.0 * * The OpenSearch Contributors require contributions made to * this file be licensed under the Apache-2.0 license or a * compatible open source license. * */ /* * Licensed to Elasticsearch B.V. under one or more contributor * license agreements. See the NOTICE file distributed with * this work for additional information regarding copyright * ownership. Elasticsearch B.V. licenses this file to you under * the Apache License, Version 2.0 (the "License"); you may * not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. */ export interface BulkCreateOperation extends BulkOperation { } export interface BulkCreateResponseItem extends BulkResponseItemBase { } export interface BulkDeleteOperation extends BulkOperation { } export interface BulkDeleteResponseItem extends BulkResponseItemBase { } export interface BulkIndexOperation extends BulkOperation { } export interface BulkIndexResponseItem extends BulkResponseItemBase { } export interface BulkOperation { _id?: Id; _index?: IndexName; retry_on_conflict?: integer; routing?: Routing; version?: VersionNumber; version_type?: VersionType; } export interface BulkOperationContainer { index?: BulkIndexOperation; create?: BulkCreateOperation; update?: BulkUpdateOperation; delete?: BulkDeleteOperation; } export interface BulkRequest extends RequestBase { index?: IndexName; pipeline?: string; refresh?: Refresh; routing?: Routing; _source?: boolean | Fields; _source_excludes?: Fields; _source_includes?: Fields; timeout?: Time; wait_for_active_shards?: WaitForActiveShards; require_alias?: boolean; body?: (BulkOperationContainer | TSource)[]; } export interface BulkResponse { errors: boolean; items: BulkResponseItemContainer[]; took: long; ingest_took?: long; } export interface BulkResponseItemBase { _id?: string | null; _index: string; status: integer; error?: ErrorCause; _primary_term?: long; result?: string; _seq_no?: SequenceNumber; _shards?: ShardStatistics; _version?: VersionNumber; forced_refresh?: boolean; get?: InlineGet>; } export interface BulkResponseItemContainer { index?: BulkIndexResponseItem; create?: BulkCreateResponseItem; update?: BulkUpdateResponseItem; delete?: BulkDeleteResponseItem; } export interface BulkUpdateOperation extends BulkOperation { } export interface BulkUpdateResponseItem extends BulkResponseItemBase { } export interface ClearScrollRequest extends RequestBase { scroll_id?: Ids; body?: { scroll_id?: Ids; }; } export interface ClearScrollResponse { succeeded: boolean; num_freed: integer; } export interface CountRequest extends RequestBase { index?: Indices; allow_no_indices?: boolean; analyzer?: string; analyze_wildcard?: boolean; default_operator?: DefaultOperator; df?: string; expand_wildcards?: ExpandWildcards; ignore_throttled?: boolean; ignore_unavailable?: boolean; lenient?: boolean; min_score?: double; preference?: string; query_on_query_string?: string; routing?: Routing; terminate_after?: long; q?: string; body?: { query?: QueryDslQueryContainer; }; } export interface CountResponse { count: long; _shards: ShardStatistics; } export interface CreateRequest extends RequestBase { id: Id; index: IndexName; pipeline?: string; refresh?: Refresh; routing?: Routing; timeout?: Time; version?: VersionNumber; version_type?: VersionType; wait_for_active_shards?: WaitForActiveShards; body?: TDocument; } export interface CreateResponse extends WriteResponseBase { } export interface DeleteRequest extends RequestBase { id: Id; index: IndexName; if_primary_term?: long; if_seq_no?: SequenceNumber; refresh?: Refresh; routing?: Routing; timeout?: Time; version?: VersionNumber; version_type?: VersionType; wait_for_active_shards?: WaitForActiveShards; } export interface DeleteResponse extends WriteResponseBase { } export interface DeleteByQueryRequest extends RequestBase { index: Indices; allow_no_indices?: boolean; analyzer?: string; analyze_wildcard?: boolean; conflicts?: Conflicts; default_operator?: DefaultOperator; df?: string; expand_wildcards?: ExpandWildcards; from?: long; ignore_unavailable?: boolean; lenient?: boolean; max_docs?: long; preference?: string; refresh?: boolean; request_cache?: boolean; requests_per_second?: long; routing?: Routing; q?: string; scroll?: Time; scroll_size?: long; search_timeout?: Time; search_type?: SearchType; size?: long; slices?: long; sort?: string[]; _source?: boolean | Fields; _source_excludes?: Fields; _source_includes?: Fields; stats?: string[]; terminate_after?: long; timeout?: Time; version?: boolean; wait_for_active_shards?: WaitForActiveShards; wait_for_completion?: boolean; body?: { max_docs?: long; query?: QueryDslQueryContainer; slice?: SlicedScroll; }; } export interface DeleteByQueryResponse { batches?: long; deleted?: long; failures?: BulkIndexByScrollFailure[]; noops?: long; requests_per_second?: float; retries?: Retries; slice_id?: integer; task?: TaskId; throttled_millis?: long; throttled_until_millis?: long; timed_out?: boolean; took?: long; total?: long; version_conflicts?: long; } export interface DeleteByQueryRethrottleRequest extends RequestBase { task_id: Id; requests_per_second?: long; } export interface DeleteByQueryRethrottleResponse extends TaskListResponse { } export interface DeleteScriptRequest extends RequestBase { id: Id cluster_manager_timeout?: Time /** * @deprecated use cluster_manager_timeout instead */ master_timeout?: Time timeout?: Time } export interface DeleteScriptResponse extends AcknowledgedResponseBase { } export interface ExistsRequest extends RequestBase { id: Id; index: IndexName; preference?: string; realtime?: boolean; refresh?: boolean; routing?: Routing; source_enabled?: boolean; source_excludes?: Fields; source_includes?: Fields; stored_fields?: Fields; version?: VersionNumber; version_type?: VersionType; } export type ExistsResponse = boolean; export interface ExistsSourceRequest extends RequestBase { id: Id; index: IndexName; preference?: string; realtime?: boolean; refresh?: boolean; routing?: Routing; source_enabled?: boolean; source_excludes?: Fields; source_includes?: Fields; version?: VersionNumber; version_type?: VersionType; } export type ExistsSourceResponse = boolean; export interface ExplainExplanation { description: string; details: ExplainExplanationDetail[]; value: float; } export interface ExplainExplanationDetail { description: string; details?: ExplainExplanationDetail[]; value: float; } export interface ExplainRequest extends RequestBase { id: Id; index: IndexName; analyzer?: string; analyze_wildcard?: boolean; default_operator?: DefaultOperator; df?: string; lenient?: boolean; preference?: string; query_on_query_string?: string; routing?: Routing; _source?: boolean | Fields; _source_excludes?: Fields; _source_includes?: Fields; stored_fields?: Fields; q?: string; body?: { query?: QueryDslQueryContainer; }; } export interface ExplainResponse { _index: IndexName; _id: Id; matched: boolean; explanation?: ExplainExplanationDetail; get?: InlineGet; } export interface FieldCapsFieldCapabilitiesBodyIndexFilter { range?: FieldCapsFieldCapabilitiesBodyIndexFilterRange; match_none?: EmptyObject; term?: FieldCapsFieldCapabilitiesBodyIndexFilterTerm; } export interface FieldCapsFieldCapabilitiesBodyIndexFilterRange { timestamp: FieldCapsFieldCapabilitiesBodyIndexFilterRangeTimestamp; } export interface FieldCapsFieldCapabilitiesBodyIndexFilterRangeTimestamp { gte?: integer; gt?: integer; lte?: integer; lt?: integer; } export interface FieldCapsFieldCapabilitiesBodyIndexFilterTerm { versionControl: FieldCapsFieldCapabilitiesBodyIndexFilterTermVersionControl; } export interface FieldCapsFieldCapabilitiesBodyIndexFilterTermVersionControl { value: string; } export interface FieldCapsFieldCapability { aggregatable: boolean; indices?: Indices; meta?: Record; non_aggregatable_indices?: Indices; non_searchable_indices?: Indices; searchable: boolean; type: string; } export interface FieldCapsRequest extends RequestBase { index?: Indices; allow_no_indices?: boolean; expand_wildcards?: ExpandWildcards; fields?: Fields; ignore_unavailable?: boolean; include_unmapped?: boolean; body?: { index_filter?: FieldCapsFieldCapabilitiesBodyIndexFilter; }; } export interface FieldCapsResponse { indices: Indices; fields: Record>; } export interface GetRequest extends RequestBase { id: Id; index: IndexName; preference?: string; realtime?: boolean; refresh?: boolean; routing?: Routing; source_enabled?: boolean; _source_excludes?: Fields; _source_includes?: Fields; stored_fields?: Fields; version?: VersionNumber; version_type?: VersionType; _source?: boolean | Fields; } export interface GetResponse { _index: IndexName; fields?: Record; found: boolean; _id: Id; _primary_term?: long; _routing?: string; _seq_no?: SequenceNumber; _source?: TDocument; _version?: VersionNumber; } export interface GetScriptRequest extends RequestBase { id: Id cluster_manager_timeout?: Time /** * @deprecated use cluster_manager_timeout instead */ master_timeout?: Time } export interface GetScriptResponse { _id: Id; found: boolean; script?: StoredScript; } export interface GetScriptContextContext { methods: GetScriptContextContextMethod[]; name: Name; } export interface GetScriptContextContextMethod { name: Name; return_type: string; params: GetScriptContextContextMethodParam[]; } export interface GetScriptContextContextMethodParam { name: Name; type: string; } export interface GetScriptContextRequest extends RequestBase { } export interface GetScriptContextResponse { contexts: GetScriptContextContext[]; } export interface GetScriptLanguagesLanguageContext { contexts: string[]; language: ScriptLanguage; } export interface GetScriptLanguagesRequest extends RequestBase { } export interface GetScriptLanguagesResponse { language_contexts: GetScriptLanguagesLanguageContext[]; types_allowed: string[]; } export interface GetSourceRequest extends GetRequest { } export type GetSourceResponse = TDocument; export interface IndexRequest extends RequestBase { id?: Id; index: IndexName; if_primary_term?: long; if_seq_no?: SequenceNumber; op_type?: OpType; pipeline?: string; refresh?: Refresh; routing?: Routing; timeout?: Time; version?: VersionNumber; version_type?: VersionType; wait_for_active_shards?: WaitForActiveShards; require_alias?: boolean; body?: TDocument; } export interface IndexResponse extends WriteResponseBase { } export interface InfoRequest extends RequestBase { } export interface InfoResponse { cluster_name: Name; cluster_uuid: Uuid; name: Name; version: OpenSearchVersionInfo; } export interface MgetHit { error?: MainError; fields?: Record; found?: boolean; _id: Id; _index: IndexName; _primary_term?: long; _routing?: Routing; _seq_no?: SequenceNumber; _source?: TDocument; _version?: VersionNumber; } export type MgetMultiGetId = string | integer; export interface MgetOperation { _id: MgetMultiGetId; _index?: IndexName; routing?: Routing; _source?: boolean | Fields | SearchSourceFilter; stored_fields?: Fields; version?: VersionNumber; version_type?: VersionType; } export interface MgetRequest extends RequestBase { index?: IndexName; preference?: string; realtime?: boolean; refresh?: boolean; routing?: Routing; _source?: boolean | Fields; _source_excludes?: Fields; _source_includes?: Fields; stored_fields?: Fields; body?: { docs?: MgetOperation[]; ids?: MgetMultiGetId[]; }; } export interface MgetResponse { docs: MgetHit[]; } export interface MsearchBody { aggregations?: Record; aggs?: Record; query?: QueryDslQueryContainer; from?: integer; size?: integer; pit?: SearchPointInTimeReference; track_total_hits?: boolean | integer; suggest?: SearchSuggestContainer | Record; } export interface MsearchHeader { allow_no_indices?: boolean; expand_wildcards?: ExpandWildcards; ignore_unavailable?: boolean; index?: Indices; preference?: string; request_cache?: boolean; routing?: string; search_type?: SearchType; } export interface MsearchRequest extends RequestBase { index?: Indices; allow_no_indices?: boolean; ccs_minimize_roundtrips?: boolean; expand_wildcards?: ExpandWildcards; ignore_throttled?: boolean; ignore_unavailable?: boolean; max_concurrent_searches?: long; max_concurrent_shard_requests?: long; pre_filter_shard_size?: long; search_type?: SearchType; rest_total_hits_as_int?: boolean; typed_keys?: boolean; body?: (MsearchHeader | MsearchBody)[]; } export interface MsearchResponse { took: long; responses: (MsearchSearchResult | ErrorResponseBase)[]; } export interface MsearchSearchResult extends SearchResponse { status: integer; } export interface MsearchTemplateRequest extends RequestBase { index?: Indices; ccs_minimize_roundtrips?: boolean; max_concurrent_searches?: long; search_type?: SearchType; rest_total_hits_as_int?: boolean; typed_keys?: boolean; body?: MsearchTemplateTemplateItem[]; } export interface MsearchTemplateResponse { responses: SearchResponse[]; took: long; } export interface MsearchTemplateTemplateItem { id?: Id; index?: Indices; params?: Record; source?: string; } export interface MtermvectorsOperation { doc: object; fields: Fields; field_statistics: boolean; filter: TermvectorsFilter; _id: Id; _index: IndexName; offsets: boolean; payloads: boolean; positions: boolean; routing: Routing; term_statistics: boolean; version: VersionNumber; version_type: VersionType; } export interface MtermvectorsRequest extends RequestBase { index?: IndexName; fields?: Fields; field_statistics?: boolean; offsets?: boolean; payloads?: boolean; positions?: boolean; preference?: string; realtime?: boolean; routing?: Routing; term_statistics?: boolean; version?: VersionNumber; version_type?: VersionType; body?: { docs?: MtermvectorsOperation[]; ids?: Id[]; }; } export interface MtermvectorsResponse { docs: MtermvectorsTermVectorsResult[]; } export interface MtermvectorsTermVectorsResult { found: boolean; id: Id; index: IndexName; term_vectors: Record; took: long; version: VersionNumber; } export interface PingRequest extends RequestBase { } export type PingResponse = boolean; export interface PutScriptRequest extends RequestBase { id: Id context?: Name cluster_manager_timeout?: Time /** * @deprecated use cluster_manager_timeout instead */ master_timeout?: Time timeout?: Time body?: { script?: StoredScript; }; } export interface PutScriptResponse extends AcknowledgedResponseBase { } export interface RankEvalDocumentRating { _id: Id; _index: IndexName; rating: integer; } export interface RankEvalRankEvalHit { _id: Id; _index: IndexName; _score: double; } export interface RankEvalRankEvalHitItem { hit: RankEvalRankEvalHit; rating?: double; } export interface RankEvalRankEvalMetric { precision?: RankEvalRankEvalMetricPrecision; recall?: RankEvalRankEvalMetricRecall; mean_reciprocal_rank?: RankEvalRankEvalMetricMeanReciprocalRank; dcg?: RankEvalRankEvalMetricDiscountedCumulativeGain; expected_reciprocal_rank?: RankEvalRankEvalMetricExpectedReciprocalRank; } export interface RankEvalRankEvalMetricBase { k?: integer; } export interface RankEvalRankEvalMetricDetail { metric_score: double; unrated_docs: RankEvalUnratedDocument[]; hits: RankEvalRankEvalHitItem[]; metric_details: Record>; } export interface RankEvalRankEvalMetricDiscountedCumulativeGain extends RankEvalRankEvalMetricBase { normalize?: boolean; } export interface RankEvalRankEvalMetricExpectedReciprocalRank extends RankEvalRankEvalMetricBase { maximum_relevance: integer; } export interface RankEvalRankEvalMetricMeanReciprocalRank extends RankEvalRankEvalMetricRatingTreshold { } export interface RankEvalRankEvalMetricPrecision extends RankEvalRankEvalMetricRatingTreshold { ignore_unlabeled?: boolean; } export interface RankEvalRankEvalMetricRatingTreshold extends RankEvalRankEvalMetricBase { relevant_rating_threshold?: integer; } export interface RankEvalRankEvalMetricRecall extends RankEvalRankEvalMetricRatingTreshold { } export interface RankEvalRankEvalQuery { query: QueryDslQueryContainer; size?: integer; } export interface RankEvalRankEvalRequestItem { id: Id; request?: RankEvalRankEvalQuery; ratings: RankEvalDocumentRating[]; template_id?: Id; params?: Record; } export interface RankEvalRequest extends RequestBase { index: Indices; allow_no_indices?: boolean; expand_wildcards?: ExpandWildcards; ignore_unavailable?: boolean; search_type?: string; body?: { requests: RankEvalRankEvalRequestItem[]; metric?: RankEvalRankEvalMetric; }; } export interface RankEvalResponse { metric_score: double; details: Record; failures: Record; } export interface RankEvalUnratedDocument { _id: Id; _index: IndexName; } export interface ReindexDestination { index: IndexName; op_type?: OpType; pipeline?: string; routing?: Routing; version_type?: VersionType; } export interface ReindexRemoteSource { connect_timeout: Time; host: Host; username: Username; password: Password; socket_timeout: Time; } export interface ReindexRequest extends RequestBase { refresh?: boolean; requests_per_second?: long; scroll?: Time; slices?: long; timeout?: Time; wait_for_active_shards?: WaitForActiveShards; wait_for_completion?: boolean; require_alias?: boolean; body?: { conflicts?: Conflicts; dest?: ReindexDestination; max_docs?: long; script?: Script; size?: long; source?: ReindexSource; }; } export interface ReindexResponse { batches?: long; created?: long; deleted?: long; failures?: BulkIndexByScrollFailure[]; noops?: long; retries?: Retries; requests_per_second?: long; slice_id?: integer; task?: TaskId; throttled_millis?: EpochMillis; throttled_until_millis?: EpochMillis; timed_out?: boolean; took?: Time; total?: long; updated?: long; version_conflicts?: long; } export interface ReindexSource { index: Indices; query?: QueryDslQueryContainer; remote?: ReindexRemoteSource; size?: integer; slice?: SlicedScroll; sort?: SearchSort; _source?: Fields; } export interface ReindexRethrottleReindexNode extends SpecUtilsBaseNode { tasks: Record; } export interface ReindexRethrottleReindexStatus { batches: long; created: long; deleted: long; noops: long; requests_per_second: float; retries: Retries; throttled_millis: long; throttled_until_millis: long; total: long; updated: long; version_conflicts: long; } export interface ReindexRethrottleReindexTask { action: string; cancellable: boolean; description: string; id: long; node: Name; running_time_in_nanos: long; start_time_in_millis: long; status: ReindexRethrottleReindexStatus; type: string; headers: HttpHeaders; } export interface ReindexRethrottleRequest extends RequestBase { task_id: Id; requests_per_second?: long; } export interface ReindexRethrottleResponse { nodes: Record; } export interface RenderSearchTemplateRequest extends RequestBase { body?: { file?: string; params?: Record; source?: string; }; } export interface RenderSearchTemplateResponse { template_output: Record; } export interface ScriptsPainlessExecutePainlessContextSetup { document: any; index: IndexName; query: QueryDslQueryContainer; } export interface ScriptsPainlessExecutePainlessExecutionPosition { offset: integer; start: integer; end: integer; } export interface ScriptsPainlessExecuteRequest extends RequestBase { body?: { context?: string; context_setup?: ScriptsPainlessExecutePainlessContextSetup; script?: InlineScript; }; } export interface ScriptsPainlessExecuteResponse { result: TResult; } export interface ScrollRequest extends RequestBase { scroll_id?: Id; scroll?: Time; rest_total_hits_as_int?: boolean; total_hits_as_integer?: boolean; body?: { scroll?: Time; scroll_id: ScrollId; rest_total_hits_as_int?: boolean; }; } export interface ScrollResponse extends SearchResponse { } export interface SearchRequest extends RequestBase { index?: Indices; allow_no_indices?: boolean; allow_partial_search_results?: boolean; analyzer?: string; analyze_wildcard?: boolean; batched_reduce_size?: long; ccs_minimize_roundtrips?: boolean; default_operator?: DefaultOperator; df?: string; docvalue_fields?: Fields; expand_wildcards?: ExpandWildcards; explain?: boolean; ignore_throttled?: boolean; ignore_unavailable?: boolean; lenient?: boolean; max_concurrent_shard_requests?: long; min_compatible_shard_node?: VersionString; preference?: string; pre_filter_shard_size?: long; request_cache?: boolean; routing?: Routing; scroll?: Time; search_type?: SearchType; stats?: string[]; stored_fields?: Fields; suggest_field?: Field; suggest_mode?: SuggestMode; suggest_size?: long; suggest_text?: string; terminate_after?: long; timeout?: Time; track_total_hits?: boolean | integer; track_scores?: boolean; typed_keys?: boolean; rest_total_hits_as_int?: boolean; version?: boolean; _source?: boolean | Fields; _source_excludes?: Fields; _source_includes?: Fields; seq_no_primary_term?: boolean; q?: string; size?: integer; from?: integer; sort?: string | string[]; body?: { aggs?: Record; aggregations?: Record; collapse?: SearchFieldCollapse; explain?: boolean; from?: integer; highlight?: SearchHighlight; track_total_hits?: boolean | integer; indices_boost?: Record[]; docvalue_fields?: SearchDocValueField | (Field | SearchDocValueField)[]; min_score?: double; post_filter?: QueryDslQueryContainer; profile?: boolean; query?: QueryDslQueryContainer; rescore?: SearchRescore | SearchRescore[]; script_fields?: Record; search_after?: (integer | string)[]; size?: integer; slice?: SlicedScroll; sort?: SearchSort; _source?: boolean | Fields | SearchSourceFilter; fields?: (Field | DateField)[]; suggest?: SearchSuggestContainer | Record; terminate_after?: long; timeout?: string; track_scores?: boolean; version?: boolean; seq_no_primary_term?: boolean; stored_fields?: Fields; pit?: SearchPointInTimeReference; runtime_mappings?: MappingRuntimeFields; stats?: string[]; }; } export interface SearchResponse { took: long; timed_out: boolean; _shards: ShardStatistics; hits: SearchHitsMetadata; aggregations?: Record; _clusters?: ClusterStatistics; documents?: TDocument[]; fields?: Record; max_score?: double; num_reduce_phases?: long; profile?: SearchProfile; pit_id?: Id; _scroll_id?: ScrollId; suggest?: Record[]>; terminated_early?: boolean; } export interface SearchAggregationBreakdown { build_aggregation: long; build_aggregation_count: long; build_leaf_collector: long; build_leaf_collector_count: long; collect: long; collect_count: long; initialize: long; initialize_count: long; post_collection?: long; post_collection_count?: long; reduce: long; reduce_count: long; } export interface SearchAggregationProfile { breakdown: SearchAggregationBreakdown; description: string; time_in_nanos: long; type: string; debug?: SearchAggregationProfileDebug; children?: SearchAggregationProfileDebug[]; } export interface SearchAggregationProfileDebug { } export type SearchBoundaryScanner = 'chars' | 'sentence' | 'word'; export interface SearchCollector { name: string; reason: string; time_in_nanos: long; children?: SearchCollector[]; } export interface SearchCompletionSuggestOption { collate_match?: boolean; contexts?: Record; fields?: Record; _id: string; _index: IndexName; _type?: Type; _routing?: Routing; _score: double; _source: TDocument; text: string; } export interface SearchCompletionSuggester extends SearchSuggesterBase { contexts?: Record; fuzzy?: SearchSuggestFuzziness; prefix?: string; regex?: string; skip_duplicates?: boolean; } export type SearchContext = string | QueryDslGeoLocation; export interface SearchDirectGenerator { field: Field; max_edits?: integer; max_inspections?: float; max_term_freq?: float; min_doc_freq?: float; min_word_length?: integer; post_filter?: string; pre_filter?: string; prefix_length?: integer; size?: integer; suggest_mode?: SuggestMode; } export interface SearchDocValueField { field: Field; format?: string; } export interface SearchFieldCollapse { field: Field; inner_hits?: SearchInnerHits | SearchInnerHits[]; max_concurrent_group_searches?: integer; } export interface SearchFieldSort { missing?: AggregationsMissing; mode?: SearchSortMode; nested?: SearchNestedSortValue; order?: SearchSortOrder; unmapped_type?: MappingFieldType; } export interface SearchGeoDistanceSortKeys { mode?: SearchSortMode; distance_type?: GeoDistanceType; order?: SearchSortOrder; unit?: DistanceUnit; } export type SearchGeoDistanceSort = | SearchGeoDistanceSortKeys | { [property: string]: QueryDslGeoLocation | QueryDslGeoLocation[] }; export interface SearchHighlight { fields: Record; type?: SearchHighlighterType; boundary_chars?: string; boundary_max_scan?: integer; boundary_scanner?: SearchBoundaryScanner; boundary_scanner_locale?: string; encoder?: SearchHighlighterEncoder; fragmenter?: SearchHighlighterFragmenter; fragment_offset?: integer; fragment_size?: integer; max_fragment_length?: integer; no_match_size?: integer; number_of_fragments?: integer; order?: SearchHighlighterOrder; post_tags?: string[]; pre_tags?: string[]; require_field_match?: boolean; tags_schema?: SearchHighlighterTagsSchema; highlight_query?: QueryDslQueryContainer; max_analyzed_offset?: string | integer; } export interface SearchHighlightField { boundary_chars?: string; boundary_max_scan?: integer; boundary_scanner?: SearchBoundaryScanner; boundary_scanner_locale?: string; field?: Field; force_source?: boolean; fragmenter?: SearchHighlighterFragmenter; fragment_offset?: integer; fragment_size?: integer; highlight_query?: QueryDslQueryContainer; matched_fields?: Fields; max_fragment_length?: integer; no_match_size?: integer; number_of_fragments?: integer; order?: SearchHighlighterOrder; phrase_limit?: integer; post_tags?: string[]; pre_tags?: string[]; require_field_match?: boolean; tags_schema?: SearchHighlighterTagsSchema; type?: SearchHighlighterType | string; } export type SearchHighlighterEncoder = 'default' | 'html'; export type SearchHighlighterFragmenter = 'simple' | 'span'; export type SearchHighlighterOrder = 'score'; export type SearchHighlighterTagsSchema = 'styled'; export type SearchHighlighterType = 'plain' | 'fvh' | 'unified'; export interface SearchHit { _index: IndexName; _id: Id; _score?: double; _explanation?: ExplainExplanation; fields?: Record; highlight?: Record; inner_hits?: Record; matched_queries?: string[]; _nested?: SearchNestedIdentity; _ignored?: string[]; _shard?: string; _node?: string; _routing?: string; _source?: TDocument; _seq_no?: SequenceNumber; _primary_term?: long; _version?: VersionNumber; sort?: SearchSortResults; } export interface SearchHitsMetadata { total: SearchTotalHits | long; hits: SearchHit[]; max_score?: double; } export interface SearchInnerHits { name?: Name; size?: integer; from?: integer; collapse?: SearchFieldCollapse; docvalue_fields?: Fields; explain?: boolean; highlight?: SearchHighlight; ignore_unmapped?: boolean; script_fields?: Record; seq_no_primary_term?: boolean; fields?: Fields; sort?: SearchSort; _source?: boolean | SearchSourceFilter; version?: boolean; } export interface SearchInnerHitsMetadata { total: SearchTotalHits | long; hits: SearchHit>[]; max_score?: double; } export interface SearchInnerHitsResult { hits: SearchInnerHitsMetadata; } export interface SearchLaplaceSmoothingModel { alpha: double; } export interface SearchLinearInterpolationSmoothingModel { bigram_lambda: double; trigram_lambda: double; unigram_lambda: double; } export interface SearchNestedIdentity { field: Field; offset: integer; _nested?: SearchNestedIdentity; } export interface SearchNestedSortValue { filter?: QueryDslQueryContainer; max_children?: integer; path: Field; } export interface SearchPhraseSuggestCollate { params?: Record; prune?: boolean; query: SearchPhraseSuggestCollateQuery; } export interface SearchPhraseSuggestCollateQuery { id?: Id; source?: string; } export interface SearchPhraseSuggestHighlight { post_tag: string; pre_tag: string; } export interface SearchPhraseSuggestOption { text: string; highlighted: string; score: double; } export interface SearchPhraseSuggester extends SearchSuggesterBase { collate?: SearchPhraseSuggestCollate; confidence?: double; direct_generator?: SearchDirectGenerator[]; force_unigrams?: boolean; gram_size?: integer; highlight?: SearchPhraseSuggestHighlight; max_errors?: double; real_word_error_likelihood?: double; separator?: string; shard_size?: integer; smoothing?: SearchSmoothingModelContainer; text?: string; token_limit?: integer; } export interface SearchPointInTimeReference { id: Id; keep_alive?: Time; } export interface SearchProfile { shards: SearchShardProfile[]; } export interface SearchQueryBreakdown { advance: long; advance_count: long; build_scorer: long; build_scorer_count: long; create_weight: long; create_weight_count: long; match: long; match_count: long; shallow_advance: long; shallow_advance_count: long; next_doc: long; next_doc_count: long; score: long; score_count: long; compute_max_score: long; compute_max_score_count: long; set_min_competitive_score: long; set_min_competitive_score_count: long; } export interface SearchQueryProfile { breakdown: SearchQueryBreakdown; description: string; time_in_nanos: long; type: string; children?: SearchQueryProfile[]; } export interface SearchRescore { query: SearchRescoreQuery; window_size?: integer; } export interface SearchRescoreQuery { rescore_query: QueryDslQueryContainer; query_weight?: double; rescore_query_weight?: double; score_mode?: SearchScoreMode; } export type SearchScoreMode = 'avg' | 'max' | 'min' | 'multiply' | 'total'; export interface SearchScoreSort { mode?: SearchSortMode; order?: SearchSortOrder; } export interface SearchScriptSort { order?: SearchSortOrder; script: Script; type?: string; } export interface SearchSearchProfile { collector: SearchCollector[]; query: SearchQueryProfile[]; rewrite_time: long; } export interface SearchShardProfile { aggregations: SearchAggregationProfile[]; id: string; searches: SearchSearchProfile[]; } export interface SearchSmoothingModelContainer { laplace?: SearchLaplaceSmoothingModel; linear_interpolation?: SearchLinearInterpolationSmoothingModel; stupid_backoff?: SearchStupidBackoffSmoothingModel; } export type SearchSort = SearchSortCombinations | SearchSortCombinations[]; export type SearchSortCombinations = Field | SearchSortContainer | SearchSortOrder; export interface SearchSortContainerKeys { _score?: SearchScoreSort; _doc?: SearchScoreSort; _geo_distance?: SearchGeoDistanceSort; _script?: SearchScriptSort; } export type SearchSortContainer = | SearchSortContainerKeys | { [property: string]: SearchFieldSort | SearchSortOrder }; export type SearchSortMode = 'min' | 'max' | 'sum' | 'avg' | 'median'; export type SearchSortOrder = 'asc' | 'desc' | '_doc'; export type SearchSortResults = (long | double | string | null)[]; export interface SearchSourceFilter { excludes?: Fields; includes?: Fields; exclude?: Fields; include?: Fields; } export type SearchStringDistance = | 'internal' | 'damerau_levenshtein' | 'levenshtein' | 'jaro_winkler' | 'ngram'; export interface SearchStupidBackoffSmoothingModel { discount: double; } export interface SearchSuggest { length: integer; offset: integer; options: SearchSuggestOption[]; text: string; } export interface SearchSuggestContainer { completion?: SearchCompletionSuggester; phrase?: SearchPhraseSuggester; prefix?: string; regex?: string; term?: SearchTermSuggester; text?: string; } export interface SearchSuggestContextQuery { boost?: double; context: SearchContext; neighbours?: Distance[] | integer[]; precision?: Distance | integer; prefix?: boolean; } export interface SearchSuggestFuzziness { fuzziness: Fuzziness; min_length: integer; prefix_length: integer; transpositions: boolean; unicode_aware: boolean; } export type SearchSuggestOption = | SearchCompletionSuggestOption | SearchPhraseSuggestOption | SearchTermSuggestOption; export type SearchSuggestSort = 'score' | 'frequency'; export interface SearchSuggesterBase { field: Field; analyzer?: string; size?: integer; } export interface SearchTermSuggestOption { text: string; freq?: long; score: double; } export interface SearchTermSuggester extends SearchSuggesterBase { lowercase_terms?: boolean; max_edits?: integer; max_inspections?: integer; max_term_freq?: float; min_doc_freq?: float; min_word_length?: integer; prefix_length?: integer; shard_size?: integer; sort?: SearchSuggestSort; string_distance?: SearchStringDistance; suggest_mode?: SuggestMode; text?: string; } export interface SearchTotalHits { relation: SearchTotalHitsRelation; value: long; } export type SearchTotalHitsRelation = 'eq' | 'gte'; export interface SearchShardsRequest extends RequestBase { index?: Indices; allow_no_indices?: boolean; expand_wildcards?: ExpandWildcards; ignore_unavailable?: boolean; local?: boolean; preference?: string; routing?: Routing; } export interface SearchShardsResponse { nodes: Record; shards: NodeShard[][]; indices: Record; } export interface SearchShardsShardStoreIndex { aliases?: Name[]; filter?: QueryDslQueryContainer; } export interface SearchTemplateRequest extends RequestBase { index?: Indices; allow_no_indices?: boolean; ccs_minimize_roundtrips?: boolean; expand_wildcards?: ExpandWildcards; explain?: boolean; ignore_throttled?: boolean; ignore_unavailable?: boolean; preference?: string; profile?: boolean; routing?: Routing; scroll?: Time; search_type?: SearchType; total_hits_as_integer?: boolean; typed_keys?: boolean; body?: { id?: Id; params?: Record; source?: string; }; } export interface SearchTemplateResponse { _shards: ShardStatistics; timed_out: boolean; took: integer; hits: SearchHitsMetadata; } export interface TermsEnumRequest extends RequestBase { index: IndexName; body?: { field: Field; size?: integer; timeout?: Time; case_insensitive?: boolean; index_filter?: QueryDslQueryContainer; string?: string; search_after?: string; }; } export interface TermsEnumResponse { _shards: ShardStatistics; terms: string[]; complete: boolean; } export interface TermvectorsFieldStatistics { doc_count: integer; sum_doc_freq: long; sum_ttf: long; } export interface TermvectorsFilter { max_doc_freq?: integer; max_num_terms?: integer; max_term_freq?: integer; max_word_length?: integer; min_doc_freq?: integer; min_term_freq?: integer; min_word_length?: integer; } export interface TermvectorsRequest extends RequestBase { index: IndexName; id?: Id; fields?: Fields; field_statistics?: boolean; offsets?: boolean; payloads?: boolean; positions?: boolean; preference?: string; realtime?: boolean; routing?: Routing; term_statistics?: boolean; version?: VersionNumber; version_type?: VersionType; body?: { doc?: TDocument; filter?: TermvectorsFilter; per_field_analyzer?: Record; }; } export interface TermvectorsResponse { found: boolean; _id: Id; _index: IndexName; term_vectors?: Record; took: long; _version: VersionNumber; } export interface TermvectorsTerm { doc_freq?: integer; score?: double; term_freq: integer; tokens: TermvectorsToken[]; ttf?: integer; } export interface TermvectorsTermVector { field_statistics: TermvectorsFieldStatistics; terms: Record; } export interface TermvectorsToken { end_offset?: integer; payload?: string; position: integer; start_offset?: integer; } export interface UpdateRequest extends RequestBase { id: Id; index: IndexName; if_primary_term?: long; if_seq_no?: SequenceNumber; lang?: string; refresh?: Refresh; require_alias?: boolean; retry_on_conflict?: long; routing?: Routing; source_enabled?: boolean; timeout?: Time; wait_for_active_shards?: WaitForActiveShards; _source?: boolean | Fields; _source_excludes?: Fields; _source_includes?: Fields; body?: { detect_noop?: boolean; doc?: TPartialDocument; doc_as_upsert?: boolean; script?: Script; scripted_upsert?: boolean; _source?: boolean | SearchSourceFilter; upsert?: TDocument; }; } export interface UpdateResponse extends WriteResponseBase { get?: InlineGet; } export interface UpdateByQueryRequest extends RequestBase { index: Indices; allow_no_indices?: boolean; analyzer?: string; analyze_wildcard?: boolean; conflicts?: Conflicts; default_operator?: DefaultOperator; df?: string; expand_wildcards?: ExpandWildcards; from?: long; ignore_unavailable?: boolean; lenient?: boolean; pipeline?: string; preference?: string; query_on_query_string?: string; refresh?: boolean; request_cache?: boolean; requests_per_second?: long; routing?: Routing; scroll?: Time; scroll_size?: long; search_timeout?: Time; search_type?: SearchType; size?: long; slices?: long; sort?: string[]; source_enabled?: boolean; source_excludes?: Fields; source_includes?: Fields; stats?: string[]; terminate_after?: long; timeout?: Time; version?: boolean; version_type?: boolean; wait_for_active_shards?: WaitForActiveShards; wait_for_completion?: boolean; body?: { max_docs?: long; query?: QueryDslQueryContainer; script?: Script; slice?: SlicedScroll; conflicts?: Conflicts; }; } export interface UpdateByQueryResponse { batches?: long; failures?: BulkIndexByScrollFailure[]; noops?: long; deleted?: long; requests_per_second?: float; retries?: Retries; task?: TaskId; timed_out?: boolean; took?: long; total?: long; updated?: long; version_conflicts?: long; throttled_millis?: ulong; throttled_until_millis?: ulong; } export interface UpdateByQueryRethrottleRequest extends RequestBase { task_id: Id; requests_per_second?: long; } export interface UpdateByQueryRethrottleResponse { nodes: Record; } export interface UpdateByQueryRethrottleUpdateByQueryRethrottleNode extends SpecUtilsBaseNode { tasks: Record; } export interface SpecUtilsBaseNode { attributes: Record; host: Host; ip: Ip; name: Name; roles?: NodeRoles; transport_address: TransportAddress; } export interface AcknowledgedResponseBase { acknowledged: boolean; } export type AggregateName = string; export interface BulkIndexByScrollFailure { cause: MainError; id: Id; index: IndexName; status: integer; type: string; } export interface BulkStats { total_operations: long; total_time?: string; total_time_in_millis: long; total_size?: ByteSize; total_size_in_bytes: long; avg_time?: string; avg_time_in_millis: long; avg_size?: ByteSize; avg_size_in_bytes: long; } export type ByteSize = long | string; export type Bytes = 'b' | 'k' | 'kb' | 'm' | 'mb' | 'g' | 'gb' | 't' | 'tb' | 'p' | 'pb'; export type CategoryId = string; export interface ClusterStatistics { skipped: integer; successful: integer; total: integer; } export interface CompletionStats { size_in_bytes: long; size?: ByteSize; fields?: Record; } export type Conflicts = 'abort' | 'proceed'; export type DataStreamName = string; export interface DateField { field: Field; format?: string; include_unmapped?: boolean; } export type DateMath = string; export type DateMathTime = string; export type DateString = string; export type DefaultOperator = 'AND' | 'OR'; export interface DictionaryResponseBase { [key: string]: TValue; } export type Distance = string; export type DistanceUnit = 'in' | 'ft' | 'yd' | 'mi' | 'nmi' | 'km' | 'm' | 'cm' | 'mm'; export interface DocStats { count: long; deleted: long; } export interface OpenSearchVersionInfo { build_date: DateString; build_hash: string; build_snapshot: boolean; build_type: string; distribution: string; lucene_version: VersionString; minimum_index_compatibility_version: VersionString; minimum_wire_compatibility_version: VersionString; number: string; } export interface EmptyObject { } export type EpochMillis = string | long; export interface ErrorCause { type: string; reason: string; caused_by?: ErrorCause; shard?: integer | string; stack_trace?: string; root_cause?: ErrorCause[]; bytes_limit?: long; bytes_wanted?: long; column?: integer; col?: integer; failed_shards?: ShardFailure[]; grouped?: boolean; index?: IndexName; index_uuid?: Uuid; language?: string; licensed_expired_feature?: string; line?: integer; max_buckets?: integer; phase?: string; property_name?: string; processor_type?: string; resource_id?: Ids; 'resource.id'?: Ids; resource_type?: string; 'resource.type'?: string; script?: string; script_stack?: string[]; header?: HttpHeaders; lang?: string; position?: ScriptsPainlessExecutePainlessExecutionPosition; } export interface ErrorResponseBase { error: MainError | string; status: integer; } export type ExpandWildcardOptions = 'all' | 'open' | 'closed' | 'hidden' | 'none'; export type ExpandWildcards = ExpandWildcardOptions | ExpandWildcardOptions[] | string; export type Field = string; export interface FieldMemoryUsage { memory_size?: ByteSize; memory_size_in_bytes: long; } export interface FieldSizeUsage { size?: ByteSize; size_in_bytes: long; } export interface FielddataStats { evictions?: long; memory_size?: ByteSize; memory_size_in_bytes: long; fields?: Record; } export type Fields = Field | Field[]; export interface FlushStats { periodic: long; total: long; total_time?: string; total_time_in_millis: long; } export type Fuzziness = string | integer; export type GeoDistanceType = 'arc' | 'plane'; export type GeoHashPrecision = number; export type GeoShapeRelation = 'intersects' | 'disjoint' | 'within' | 'contains'; export type GeoTilePrecision = number; export interface GetStats { current: long; exists_time?: string; exists_time_in_millis: long; exists_total: long; missing_time?: string; missing_time_in_millis: long; missing_total: long; time?: string; time_in_millis: long; total: long; } export type GroupBy = 'nodes' | 'parents' | 'none'; export type Health = 'green' | 'yellow' | 'red'; export type Host = string; export type HttpHeaders = Record; export type Id = string; export type Ids = Id | Id[]; export type IndexAlias = string; export type IndexName = string; export type IndexPattern = string; export type IndexPatterns = IndexPattern[]; export interface IndexedScript extends ScriptBase { id: Id; } export interface IndexingStats { index_current: long; delete_current: long; delete_time?: string; delete_time_in_millis: long; delete_total: long; is_throttled: boolean; noop_update_total: long; throttle_time?: string; throttle_time_in_millis: long; index_time?: string; index_time_in_millis: long; index_total: long; index_failed: long; types?: Record; } export type Indices = string | string[]; export interface IndicesResponseBase extends AcknowledgedResponseBase { _shards?: ShardStatistics; } export interface InlineGet { fields?: Record; found: boolean; _seq_no: SequenceNumber; _primary_term: long; _routing?: Routing; _source: TDocument; } export interface InlineScript extends ScriptBase { source: string; } export type Ip = string; export interface LatLon { lat: double; lon: double; } export type Level = 'cluster' | 'indices' | 'shards'; export type LifecycleOperationMode = 'RUNNING' | 'STOPPING' | 'STOPPED'; export interface MainError extends ErrorCause { headers?: Record; root_cause: ErrorCause[]; } export interface MergesStats { current: long; current_docs: long; current_size?: string; current_size_in_bytes: long; total: long; total_auto_throttle?: string; total_auto_throttle_in_bytes: long; total_docs: long; total_size?: string; total_size_in_bytes: long; total_stopped_time?: string; total_stopped_time_in_millis: long; total_throttled_time?: string; total_throttled_time_in_millis: long; total_time?: string; total_time_in_millis: long; } export type Metadata = Record; export type Metrics = string | string[]; export type MinimumShouldMatch = integer | string; export type MultiTermQueryRewrite = string; export type Name = string; export type Names = string | string[]; export type Namespace = string; export interface NodeAttributes { attributes: Record; ephemeral_id: Id; id?: Id; name: NodeName; transport_address: TransportAddress; roles?: NodeRoles; } export type NodeId = string; export type NodeIds = string; export type NodeName = string; // TODO: remove master role if it is not supported. export type NodeRole = 'cluster_manager' | 'master' | 'data' | 'client' | 'ingest' | 'voting_only' | 'remote_cluster_client' | 'coordinating_only' export type NodeRoles = NodeRole[]; export interface NodeShard { state: IndicesStatsShardRoutingState; primary: boolean; node?: NodeName; shard: integer; index: IndexName; allocation_id?: Record; recovery_source?: Record; unassigned_info?: ClusterAllocationExplainUnassignedInformation; } export interface NodeStatistics { failures?: ErrorCause[]; total: integer; successful: integer; failed: integer; } export type OpType = 'index' | 'create'; export type Password = string; export type Percentage = string | float; export type PipelineName = string; export interface PluginStats { classname: string; description: string; opensearch_version: VersionString; extended_plugins: string[]; has_native_controller: boolean; java_version: VersionString; name: Name; version: VersionString; licensed: boolean; type: string; } export type PropertyName = string; export interface QueryCacheStats { cache_count: integer; cache_size: integer; evictions: integer; hit_count: integer; memory_size?: ByteSize; memory_size_in_bytes: integer; miss_count: integer; total_count: integer; } export interface RecoveryStats { current_as_source: long; current_as_target: long; throttle_time?: string; throttle_time_in_millis: long; } export type Refresh = boolean | RefreshOptions; export type RefreshOptions = 'wait_for'; export interface RefreshStats { external_total: long; external_total_time_in_millis: long; listeners: long; total: long; total_time?: string; total_time_in_millis: long; } export type RelationName = string; export interface RequestBase extends SpecUtilsCommonQueryParameters { } export interface RequestCacheStats { evictions: long; hit_count: long; memory_size?: string; memory_size_in_bytes: long; miss_count: long; } export type Result = 'Error' | 'created' | 'updated' | 'deleted' | 'not_found' | 'noop'; export interface Retries { bulk: long; search: long; } export type Routing = string | number; export type Script = InlineScript | IndexedScript | string; export interface ScriptBase { lang?: ScriptLanguage; params?: Record; } export interface ScriptField { script: Script; } export type ScriptLanguage = 'painless' | 'expression' | 'mustache' | 'java'; export interface ScriptTransform { lang: string; params: Record; } export type ScrollId = string; export interface SearchStats { fetch_current: long; fetch_time_in_millis: long; fetch_total: long; open_contexts?: long; query_current: long; query_time_in_millis: long; query_total: long; scroll_current: long; scroll_time_in_millis: long; scroll_total: long; suggest_current: long; suggest_time_in_millis: long; suggest_total: long; groups?: Record; } export interface SearchTransform { timeout: Time; } export type SearchType = 'query_then_fetch' | 'dfs_query_then_fetch'; export interface SegmentsStats { count: integer; doc_values_memory?: ByteSize; doc_values_memory_in_bytes: integer; file_sizes: Record; fixed_bit_set?: ByteSize; fixed_bit_set_memory_in_bytes: integer; index_writer_memory?: ByteSize; index_writer_max_memory_in_bytes?: integer; index_writer_memory_in_bytes: integer; max_unsafe_auto_id_timestamp: integer; memory?: ByteSize; memory_in_bytes: integer; norms_memory?: ByteSize; norms_memory_in_bytes: integer; points_memory?: ByteSize; points_memory_in_bytes: integer; stored_memory?: ByteSize; stored_fields_memory_in_bytes: integer; terms_memory_in_bytes: integer; terms_memory?: ByteSize; term_vectory_memory?: ByteSize; term_vectors_memory_in_bytes: integer; version_map_memory?: ByteSize; version_map_memory_in_bytes: integer; } export type SequenceNumber = integer; export type Service = string; export type ShapeRelation = 'intersects' | 'disjoint' | 'within'; export interface ShardFailure { index?: IndexName; node?: string; reason: ErrorCause; shard: integer; status?: string; } export interface ShardStatistics { failed: uint; successful: uint; total: uint; failures?: ShardFailure[]; skipped?: uint; } export interface ShardsOperationResponseBase { _shards: ShardStatistics; } export type Size = 'Raw' | 'k' | 'm' | 'g' | 't' | 'p'; export interface SlicedScroll { field?: Field; id: integer; max: integer; } export interface StoreStats { size?: ByteSize; size_in_bytes: integer; reserved?: ByteSize; reserved_in_bytes: integer; total_data_set_size?: ByteSize; total_data_set_size_in_bytes?: integer; } export interface StoredScript { lang?: ScriptLanguage; source: string; } export type SuggestMode = 'missing' | 'popular' | 'always'; export type SuggestionName = string; export type TaskId = string | integer; export type ThreadType = 'cpu' | 'wait' | 'block'; export type Time = string | integer; export type TimeSpan = string; export type Timestamp = string; export interface TranslogStats { earliest_last_modified_age: long; operations: long; size?: string; size_in_bytes: long; uncommitted_operations: integer; uncommitted_size?: string; uncommitted_size_in_bytes: long; } export type TransportAddress = string; export type Type = string; export type Types = Type | Type[]; export type Username = string; export type Uuid = string; export type VersionNumber = long; export type VersionString = string; export type VersionType = 'internal' | 'external' | 'external_gte' | 'force'; export type WaitForActiveShardOptions = 'all'; export type WaitForActiveShards = integer | WaitForActiveShardOptions; export type WaitForEvents = 'immediate' | 'urgent' | 'high' | 'normal' | 'low' | 'languid'; export type WaitForStatus = 'green' | 'yellow' | 'red'; export interface WarmerStats { current: long; total: long; total_time?: string; total_time_in_millis: long; } export interface WriteResponseBase { _id: Id; _index: IndexName; _primary_term: long; result: Result; _seq_no: SequenceNumber; _shards: ShardStatistics; _version: VersionNumber; forced_refresh?: boolean; error?: ErrorCause; } export type double = number; export type float = number; export type integer = number; export type long = number; export type uint = number; export type ulong = number; export interface AggregationsAdjacencyMatrixAggregation extends AggregationsBucketAggregationBase { filters?: Record; } export type AggregationsAggregate = | AggregationsSingleBucketAggregate | AggregationsAutoDateHistogramAggregate | AggregationsFiltersAggregate | AggregationsSignificantTermsAggregate | AggregationsTermsAggregate | AggregationsBucketAggregate | AggregationsCompositeBucketAggregate | AggregationsMultiBucketAggregate | AggregationsMatrixStatsAggregate | AggregationsKeyedValueAggregate | AggregationsMetricAggregate; export interface AggregationsAggregateBase { meta?: Record; } export interface AggregationsAggregation { meta?: Record; name?: string; } export interface AggregationsAggregationContainer { aggs?: Record; meta?: Record; adjacency_matrix?: AggregationsAdjacencyMatrixAggregation; aggregations?: Record; auto_date_histogram?: AggregationsAutoDateHistogramAggregation; avg?: AggregationsAverageAggregation; avg_bucket?: AggregationsAverageBucketAggregation; boxplot?: AggregationsBoxplotAggregation; bucket_script?: AggregationsBucketScriptAggregation; bucket_selector?: AggregationsBucketSelectorAggregation; bucket_sort?: AggregationsBucketSortAggregation; cardinality?: AggregationsCardinalityAggregation; children?: AggregationsChildrenAggregation; composite?: AggregationsCompositeAggregation; cumulative_cardinality?: AggregationsCumulativeCardinalityAggregation; cumulative_sum?: AggregationsCumulativeSumAggregation; date_histogram?: AggregationsDateHistogramAggregation; date_range?: AggregationsDateRangeAggregation; derivative?: AggregationsDerivativeAggregation; diversified_sampler?: AggregationsDiversifiedSamplerAggregation; extended_stats?: AggregationsExtendedStatsAggregation; extended_stats_bucket?: AggregationsExtendedStatsBucketAggregation; filter?: QueryDslQueryContainer; filters?: AggregationsFiltersAggregation; geo_bounds?: AggregationsGeoBoundsAggregation; geo_centroid?: AggregationsGeoCentroidAggregation; geo_distance?: AggregationsGeoDistanceAggregation; geohash_grid?: AggregationsGeoHashGridAggregation; geo_line?: AggregationsGeoLineAggregation; geotile_grid?: AggregationsGeoTileGridAggregation; global?: AggregationsGlobalAggregation; histogram?: AggregationsHistogramAggregation; ip_range?: AggregationsIpRangeAggregation; inference?: AggregationsInferenceAggregation; line?: AggregationsGeoLineAggregation; matrix_stats?: AggregationsMatrixStatsAggregation; max?: AggregationsMaxAggregation; max_bucket?: AggregationsMaxBucketAggregation; median_absolute_deviation?: AggregationsMedianAbsoluteDeviationAggregation; min?: AggregationsMinAggregation; min_bucket?: AggregationsMinBucketAggregation; missing?: AggregationsMissingAggregation; moving_avg?: AggregationsMovingAverageAggregation; moving_percentiles?: AggregationsMovingPercentilesAggregation; moving_fn?: AggregationsMovingFunctionAggregation; multi_terms?: AggregationsMultiTermsAggregation; nested?: AggregationsNestedAggregation; normalize?: AggregationsNormalizeAggregation; parent?: AggregationsParentAggregation; percentile_ranks?: AggregationsPercentileRanksAggregation; percentiles?: AggregationsPercentilesAggregation; percentiles_bucket?: AggregationsPercentilesBucketAggregation; range?: AggregationsRangeAggregation; rare_terms?: AggregationsRareTermsAggregation; rate?: AggregationsRateAggregation; reverse_nested?: AggregationsReverseNestedAggregation; sampler?: AggregationsSamplerAggregation; scripted_metric?: AggregationsScriptedMetricAggregation; serial_diff?: AggregationsSerialDifferencingAggregation; significant_terms?: AggregationsSignificantTermsAggregation; significant_text?: AggregationsSignificantTextAggregation; stats?: AggregationsStatsAggregation; stats_bucket?: AggregationsStatsBucketAggregation; string_stats?: AggregationsStringStatsAggregation; sum?: AggregationsSumAggregation; sum_bucket?: AggregationsSumBucketAggregation; terms?: AggregationsTermsAggregation; top_hits?: AggregationsTopHitsAggregation; t_test?: AggregationsTTestAggregation; top_metrics?: AggregationsTopMetricsAggregation; value_count?: AggregationsValueCountAggregation; weighted_avg?: AggregationsWeightedAverageAggregation; variable_width_histogram?: AggregationsVariableWidthHistogramAggregation; } export interface AggregationsAggregationRange { from?: double | string; key?: string; to?: double | string; } export interface AggregationsAutoDateHistogramAggregate extends AggregationsMultiBucketAggregate> { interval: DateMathTime; } export interface AggregationsAutoDateHistogramAggregation extends AggregationsBucketAggregationBase { buckets?: integer; field?: Field; format?: string; minimum_interval?: AggregationsMinimumInterval; missing?: DateString; offset?: string; params?: Record; script?: Script; time_zone?: string; } export interface AggregationsAverageAggregation extends AggregationsFormatMetricAggregationBase { } export interface AggregationsAverageBucketAggregation extends AggregationsPipelineAggregationBase { } export interface AggregationsBoxPlotAggregate extends AggregationsAggregateBase { min: double; max: double; q1: double; q2: double; q3: double; } export interface AggregationsBoxplotAggregation extends AggregationsMetricAggregationBase { compression?: double; } export type AggregationsBucket = | AggregationsCompositeBucket | AggregationsDateHistogramBucket | AggregationsFiltersBucketItem | AggregationsIpRangeBucket | AggregationsRangeBucket | AggregationsRareTermsBucket | AggregationsSignificantTermsBucket | AggregationsKeyedBucket; export interface AggregationsBucketAggregate extends AggregationsAggregateBase { after_key: Record; bg_count: long; doc_count: long; doc_count_error_upper_bound: long; sum_other_doc_count: long; interval: DateMathTime; items: AggregationsBucket; } export interface AggregationsBucketAggregationBase extends AggregationsAggregation { aggregations?: Record; } export interface AggregationsBucketScriptAggregation extends AggregationsPipelineAggregationBase { script?: Script; } export interface AggregationsBucketSelectorAggregation extends AggregationsPipelineAggregationBase { script?: Script; } export interface AggregationsBucketSortAggregation extends AggregationsAggregation { from?: integer; gap_policy?: AggregationsGapPolicy; size?: integer; sort?: SearchSort; } export interface AggregationsBucketsPath { } export interface AggregationsCardinalityAggregation extends AggregationsMetricAggregationBase { precision_threshold?: integer; rehash?: boolean; } export interface AggregationsChiSquareHeuristic { background_is_superset: boolean; include_negatives: boolean; } export interface AggregationsChildrenAggregation extends AggregationsBucketAggregationBase { type?: RelationName; } export interface AggregationsClassificationInferenceOptions { num_top_classes?: integer; num_top_feature_importance_values?: integer; prediction_field_type?: string; results_field?: string; top_classes_results_field?: string; } export interface AggregationsCompositeAggregation extends AggregationsBucketAggregationBase { after?: Record; size?: integer; sources?: Record[]; } export interface AggregationsCompositeAggregationSource { terms?: AggregationsTermsAggregation; histogram?: AggregationsHistogramAggregation; date_histogram?: AggregationsDateHistogramAggregation; geotile_grid?: AggregationsGeoTileGridAggregation; } export interface AggregationsCompositeBucketKeys { } export type AggregationsCompositeBucket = | AggregationsCompositeBucketKeys | { [property: string]: AggregationsAggregate }; export interface AggregationsCompositeBucketAggregate extends AggregationsMultiBucketAggregate> { after_key: Record; } export interface AggregationsCumulativeCardinalityAggregation extends AggregationsPipelineAggregationBase { } export interface AggregationsCumulativeSumAggregation extends AggregationsPipelineAggregationBase { } export interface AggregationsDateHistogramAggregation extends AggregationsBucketAggregationBase { calendar_interval?: AggregationsDateInterval | Time; extended_bounds?: AggregationsExtendedBounds; hard_bounds?: AggregationsExtendedBounds; field?: Field; fixed_interval?: AggregationsDateInterval | Time; format?: string; interval?: AggregationsDateInterval | Time; min_doc_count?: integer; missing?: DateString; offset?: Time; order?: AggregationsHistogramOrder; params?: Record; script?: Script; time_zone?: string; } export interface AggregationsDateHistogramBucketKeys { } export type AggregationsDateHistogramBucket = | AggregationsDateHistogramBucketKeys | { [property: string]: AggregationsAggregate }; export type AggregationsDateInterval = | 'second' | 'minute' | 'hour' | 'day' | 'week' | 'month' | 'quarter' | 'year'; export interface AggregationsDateRangeAggregation extends AggregationsBucketAggregationBase { field?: Field; format?: string; missing?: AggregationsMissing; ranges?: AggregationsDateRangeExpression[]; time_zone?: string; } export interface AggregationsDateRangeExpression { from?: DateMath | float; from_as_string?: string; to_as_string?: string; key?: string; to?: DateMath | float; doc_count?: long; } export interface AggregationsDerivativeAggregation extends AggregationsPipelineAggregationBase { } export interface AggregationsDiversifiedSamplerAggregation extends AggregationsBucketAggregationBase { execution_hint?: AggregationsSamplerAggregationExecutionHint; max_docs_per_value?: integer; script?: Script; shard_size?: integer; field?: Field; } export interface AggregationsEwmaModelSettings { alpha?: float; } export interface AggregationsExtendedBounds { max: T; min: T; } export interface AggregationsExtendedStatsAggregate extends AggregationsStatsAggregate { std_deviation_bounds: AggregationsStandardDeviationBounds; sum_of_squares?: double; variance?: double; variance_population?: double; variance_sampling?: double; std_deviation?: double; std_deviation_population?: double; std_deviation_sampling?: double; } export interface AggregationsExtendedStatsAggregation extends AggregationsFormatMetricAggregationBase { sigma?: double; } export interface AggregationsExtendedStatsBucketAggregation extends AggregationsPipelineAggregationBase { sigma?: double; } export interface AggregationsFiltersAggregate extends AggregationsAggregateBase { buckets: AggregationsFiltersBucketItem[] | Record; } export interface AggregationsFiltersAggregation extends AggregationsBucketAggregationBase { filters?: Record | QueryDslQueryContainer[]; other_bucket?: boolean; other_bucket_key?: string; } export interface AggregationsFiltersBucketItemKeys { doc_count: long; } export type AggregationsFiltersBucketItem = | AggregationsFiltersBucketItemKeys | { [property: string]: AggregationsAggregate }; export interface AggregationsFormatMetricAggregationBase extends AggregationsMetricAggregationBase { format?: string; } export interface AggregationsFormattableMetricAggregation extends AggregationsMetricAggregationBase { format?: string; } export type AggregationsGapPolicy = 'skip' | 'insert_zeros'; export interface AggregationsGeoBounds { bottom_right: LatLon; top_left: LatLon; } export interface AggregationsGeoBoundsAggregate extends AggregationsAggregateBase { bounds: AggregationsGeoBounds; } export interface AggregationsGeoBoundsAggregation extends AggregationsMetricAggregationBase { wrap_longitude?: boolean; } export interface AggregationsGeoCentroidAggregate extends AggregationsAggregateBase { count: long; location: QueryDslGeoLocation; } export interface AggregationsGeoCentroidAggregation extends AggregationsMetricAggregationBase { count?: long; location?: QueryDslGeoLocation; } export interface AggregationsGeoDistanceAggregation extends AggregationsBucketAggregationBase { distance_type?: GeoDistanceType; field?: Field; origin?: QueryDslGeoLocation | string; ranges?: AggregationsAggregationRange[]; unit?: DistanceUnit; } export interface AggregationsGeoHashGridAggregation extends AggregationsBucketAggregationBase { bounds?: QueryDslBoundingBox; field?: Field; precision?: GeoHashPrecision; shard_size?: integer; size?: integer; } export interface AggregationsGeoLineAggregate extends AggregationsAggregateBase { type: string; geometry: AggregationsLineStringGeoShape; properties: AggregationsGeoLineProperties; } export interface AggregationsGeoLineAggregation { point: AggregationsGeoLinePoint; sort: AggregationsGeoLineSort; include_sort?: boolean; sort_order?: SearchSortOrder; size?: integer; } export interface AggregationsGeoLinePoint { field: Field; } export interface AggregationsGeoLineProperties { complete: boolean; sort_values: double[]; } export interface AggregationsGeoLineSort { field: Field; } export interface AggregationsGeoTileGridAggregation extends AggregationsBucketAggregationBase { field?: Field; precision?: GeoTilePrecision; shard_size?: integer; size?: integer; bounds?: AggregationsGeoBounds; } export interface AggregationsGlobalAggregation extends AggregationsBucketAggregationBase { } export interface AggregationsGoogleNormalizedDistanceHeuristic { background_is_superset: boolean; } export interface AggregationsHdrMethod { number_of_significant_value_digits?: integer; } export interface AggregationsHdrPercentileItem { key: double; value: double; } export interface AggregationsHdrPercentilesAggregate extends AggregationsAggregateBase { values: AggregationsHdrPercentileItem[]; } export interface AggregationsHistogramAggregation extends AggregationsBucketAggregationBase { extended_bounds?: AggregationsExtendedBounds; hard_bounds?: AggregationsExtendedBounds; field?: Field; interval?: double; min_doc_count?: integer; missing?: double; offset?: double; order?: AggregationsHistogramOrder; script?: Script; format?: string; } export interface AggregationsHistogramOrder { _count?: SearchSortOrder; _key?: SearchSortOrder; } export interface AggregationsHoltLinearModelSettings { alpha?: float; beta?: float; } export interface AggregationsHoltWintersModelSettings { alpha?: float; beta?: float; gamma?: float; pad?: boolean; period?: integer; type?: AggregationsHoltWintersType; } export type AggregationsHoltWintersType = 'add' | 'mult'; export interface AggregationsInferenceAggregation extends AggregationsPipelineAggregationBase { model_id: Name; inference_config?: AggregationsInferenceConfigContainer; } export interface AggregationsInferenceConfigContainer { regression?: AggregationsRegressionInferenceOptions; classification?: AggregationsClassificationInferenceOptions; } export interface AggregationsIpRangeAggregation extends AggregationsBucketAggregationBase { field?: Field; ranges?: AggregationsIpRangeAggregationRange[]; } export interface AggregationsIpRangeAggregationRange { from?: string; mask?: string; to?: string; } export interface AggregationsIpRangeBucketKeys { } export type AggregationsIpRangeBucket = | AggregationsIpRangeBucketKeys | { [property: string]: AggregationsAggregate }; export interface AggregationsKeyedBucketKeys { doc_count: long; key: TKey; key_as_string: string; } export type AggregationsKeyedBucket = | AggregationsKeyedBucketKeys | { [property: string]: AggregationsAggregate }; export interface AggregationsKeyedValueAggregate extends AggregationsValueAggregate { keys: string[]; } export interface AggregationsLineStringGeoShape { coordinates: QueryDslGeoCoordinate[]; } export interface AggregationsMatrixAggregation extends AggregationsAggregation { fields?: Fields; missing?: Record; } export interface AggregationsMatrixStatsAggregate extends AggregationsAggregateBase { correlation: Record; covariance: Record; count: integer; kurtosis: double; mean: double; skewness: double; variance: double; name: string; } export interface AggregationsMatrixStatsAggregation extends AggregationsMatrixAggregation { mode?: AggregationsMatrixStatsMode; } export type AggregationsMatrixStatsMode = 'avg' | 'min' | 'max' | 'sum' | 'median'; export interface AggregationsMaxAggregation extends AggregationsFormatMetricAggregationBase { } export interface AggregationsMaxBucketAggregation extends AggregationsPipelineAggregationBase { } export interface AggregationsMedianAbsoluteDeviationAggregation extends AggregationsFormatMetricAggregationBase { compression?: double; } export type AggregationsMetricAggregate = | AggregationsValueAggregate | AggregationsBoxPlotAggregate | AggregationsGeoBoundsAggregate | AggregationsGeoCentroidAggregate | AggregationsGeoLineAggregate | AggregationsPercentilesAggregate | AggregationsScriptedMetricAggregate | AggregationsStatsAggregate | AggregationsStringStatsAggregate | AggregationsTopHitsAggregate | AggregationsTopMetricsAggregate | AggregationsExtendedStatsAggregate | AggregationsTDigestPercentilesAggregate | AggregationsHdrPercentilesAggregate; export interface AggregationsMetricAggregationBase { field?: Field; missing?: AggregationsMissing; script?: Script; } export interface AggregationsMinAggregation extends AggregationsFormatMetricAggregationBase { } export interface AggregationsMinBucketAggregation extends AggregationsPipelineAggregationBase { } export type AggregationsMinimumInterval = 'second' | 'minute' | 'hour' | 'day' | 'month' | 'year'; export type AggregationsMissing = string | integer | double | boolean; export interface AggregationsMissingAggregation extends AggregationsBucketAggregationBase { field?: Field; missing?: AggregationsMissing; } export interface AggregationsMovingAverageAggregation extends AggregationsPipelineAggregationBase { minimize?: boolean; model?: AggregationsMovingAverageModel; settings: AggregationsMovingAverageSettings; predict?: integer; window?: integer; } export type AggregationsMovingAverageModel = 'linear' | 'simple' | 'ewma' | 'holt' | 'holt_winters'; export type AggregationsMovingAverageSettings = | AggregationsEwmaModelSettings | AggregationsHoltLinearModelSettings | AggregationsHoltWintersModelSettings; export interface AggregationsMovingFunctionAggregation extends AggregationsPipelineAggregationBase { script?: string; shift?: integer; window?: integer; } export interface AggregationsMovingPercentilesAggregation extends AggregationsPipelineAggregationBase { window?: integer; shift?: integer; } export interface AggregationsMultiBucketAggregate extends AggregationsAggregateBase { buckets: TBucket[]; } export interface AggregationsMultiTermLookup { field: Field; } export interface AggregationsMultiTermsAggregation extends AggregationsBucketAggregationBase { terms: AggregationsMultiTermLookup[]; } export interface AggregationsMutualInformationHeuristic { background_is_superset: boolean; include_negatives: boolean; } export interface AggregationsNestedAggregation extends AggregationsBucketAggregationBase { path?: Field; } export interface AggregationsNormalizeAggregation extends AggregationsPipelineAggregationBase { method?: AggregationsNormalizeMethod; } export type AggregationsNormalizeMethod = | 'rescale_0_1' | 'rescale_0_100' | 'percent_of_sum' | 'mean' | 'zscore' | 'softmax'; export interface AggregationsParentAggregation extends AggregationsBucketAggregationBase { type?: RelationName; } export interface AggregationsPercentageScoreHeuristic { } export interface AggregationsPercentileItem { percentile: double; value: double; } export interface AggregationsPercentileRanksAggregation extends AggregationsFormatMetricAggregationBase { keyed?: boolean; values?: double[]; hdr?: AggregationsHdrMethod; tdigest?: AggregationsTDigest; } export interface AggregationsPercentilesAggregate extends AggregationsAggregateBase { items: AggregationsPercentileItem[]; } export interface AggregationsPercentilesAggregation extends AggregationsFormatMetricAggregationBase { keyed?: boolean; percents?: double[]; hdr?: AggregationsHdrMethod; tdigest?: AggregationsTDigest; } export interface AggregationsPercentilesBucketAggregation extends AggregationsPipelineAggregationBase { percents?: double[]; } export interface AggregationsPipelineAggregationBase extends AggregationsAggregation { buckets_path?: AggregationsBucketsPath; format?: string; gap_policy?: AggregationsGapPolicy; } export interface AggregationsRangeAggregation extends AggregationsBucketAggregationBase { field?: Field; ranges?: AggregationsAggregationRange[]; script?: Script; } export interface AggregationsRangeBucketKeys { } export type AggregationsRangeBucket = | AggregationsRangeBucketKeys | { [property: string]: AggregationsAggregate }; export interface AggregationsRareTermsAggregation extends AggregationsBucketAggregationBase { exclude?: string | string[]; field?: Field; include?: string | string[] | AggregationsTermsInclude; max_doc_count?: long; missing?: AggregationsMissing; precision?: double; value_type?: string; } export interface AggregationsRareTermsBucketKeys { } export type AggregationsRareTermsBucket = | AggregationsRareTermsBucketKeys | { [property: string]: AggregationsAggregate }; export interface AggregationsRateAggregation extends AggregationsFormatMetricAggregationBase { unit?: AggregationsDateInterval; mode?: AggregationsRateMode; } export type AggregationsRateMode = 'sum' | 'value_count'; export interface AggregationsRegressionInferenceOptions { results_field: Field; num_top_feature_importance_values?: integer; } export interface AggregationsReverseNestedAggregation extends AggregationsBucketAggregationBase { path?: Field; } export interface AggregationsSamplerAggregation extends AggregationsBucketAggregationBase { shard_size?: integer; } export type AggregationsSamplerAggregationExecutionHint = 'map' | 'global_ordinals' | 'bytes_hash'; export interface AggregationsScriptedHeuristic { script: Script; } export interface AggregationsScriptedMetricAggregate extends AggregationsAggregateBase { value: any; } export interface AggregationsScriptedMetricAggregation extends AggregationsMetricAggregationBase { combine_script?: Script; init_script?: Script; map_script?: Script; params?: Record; reduce_script?: Script; } export interface AggregationsSerialDifferencingAggregation extends AggregationsPipelineAggregationBase { lag?: integer; } export interface AggregationsSignificantTermsAggregate extends AggregationsMultiBucketAggregate { bg_count: long; doc_count: long; } export interface AggregationsSignificantTermsAggregation extends AggregationsBucketAggregationBase { background_filter?: QueryDslQueryContainer; chi_square?: AggregationsChiSquareHeuristic; exclude?: string | string[]; execution_hint?: AggregationsTermsAggregationExecutionHint; field?: Field; gnd?: AggregationsGoogleNormalizedDistanceHeuristic; include?: string | string[]; min_doc_count?: long; mutual_information?: AggregationsMutualInformationHeuristic; percentage?: AggregationsPercentageScoreHeuristic; script_heuristic?: AggregationsScriptedHeuristic; shard_min_doc_count?: long; shard_size?: integer; size?: integer; } export interface AggregationsSignificantTermsBucketKeys { } export type AggregationsSignificantTermsBucket = | AggregationsSignificantTermsBucketKeys | { [property: string]: AggregationsAggregate }; export interface AggregationsSignificantTextAggregation extends AggregationsBucketAggregationBase { background_filter?: QueryDslQueryContainer; chi_square?: AggregationsChiSquareHeuristic; exclude?: string | string[]; execution_hint?: AggregationsTermsAggregationExecutionHint; field?: Field; filter_duplicate_text?: boolean; gnd?: AggregationsGoogleNormalizedDistanceHeuristic; include?: string | string[]; min_doc_count?: long; mutual_information?: AggregationsMutualInformationHeuristic; percentage?: AggregationsPercentageScoreHeuristic; script_heuristic?: AggregationsScriptedHeuristic; shard_min_doc_count?: long; shard_size?: integer; size?: integer; source_fields?: Fields; } export interface AggregationsSingleBucketAggregateKeys extends AggregationsAggregateBase { doc_count: double; } export type AggregationsSingleBucketAggregate = | AggregationsSingleBucketAggregateKeys | { [property: string]: AggregationsAggregate }; export interface AggregationsStandardDeviationBounds { lower?: double; upper?: double; lower_population?: double; upper_population?: double; lower_sampling?: double; upper_sampling?: double; } export interface AggregationsStatsAggregate extends AggregationsAggregateBase { count: double; sum: double; avg?: double; max?: double; min?: double; } export interface AggregationsStatsAggregation extends AggregationsFormatMetricAggregationBase { } export interface AggregationsStatsBucketAggregation extends AggregationsPipelineAggregationBase { } export interface AggregationsStringStatsAggregate extends AggregationsAggregateBase { count: long; min_length: integer; max_length: integer; avg_length: double; entropy: double; distribution?: Record; } export interface AggregationsStringStatsAggregation extends AggregationsMetricAggregationBase { show_distribution?: boolean; } export interface AggregationsSumAggregation extends AggregationsFormatMetricAggregationBase { } export interface AggregationsSumBucketAggregation extends AggregationsPipelineAggregationBase { } export interface AggregationsTDigest { compression?: integer; } export interface AggregationsTDigestPercentilesAggregate extends AggregationsAggregateBase { values: Record; } export interface AggregationsTTestAggregation extends AggregationsAggregation { a?: AggregationsTestPopulation; b?: AggregationsTestPopulation; type?: AggregationsTTestType; } export type AggregationsTTestType = 'paired' | 'homoscedastic' | 'heteroscedastic'; export interface AggregationsTermsAggregate extends AggregationsMultiBucketAggregate { doc_count_error_upper_bound: long; sum_other_doc_count: long; } export interface AggregationsTermsAggregation extends AggregationsBucketAggregationBase { collect_mode?: AggregationsTermsAggregationCollectMode; exclude?: string | string[]; execution_hint?: AggregationsTermsAggregationExecutionHint; field?: Field; include?: string | string[] | AggregationsTermsInclude; min_doc_count?: integer; missing?: AggregationsMissing; missing_bucket?: boolean; value_type?: string; order?: AggregationsTermsAggregationOrder; script?: Script; shard_size?: integer; show_term_doc_count_error?: boolean; size?: integer; } export type AggregationsTermsAggregationCollectMode = 'depth_first' | 'breadth_first'; export type AggregationsTermsAggregationExecutionHint = | 'map' | 'global_ordinals' | 'global_ordinals_hash' | 'global_ordinals_low_cardinality'; export type AggregationsTermsAggregationOrder = | SearchSortOrder | Record | Record[]; export interface AggregationsTermsInclude { num_partitions: long; partition: long; } export interface AggregationsTestPopulation { field: Field; script?: Script; filter?: QueryDslQueryContainer; } export interface AggregationsTopHitsAggregate extends AggregationsAggregateBase { hits: SearchHitsMetadata>; } export interface AggregationsTopHitsAggregation extends AggregationsMetricAggregationBase { docvalue_fields?: Fields; explain?: boolean; from?: integer; highlight?: SearchHighlight; script_fields?: Record; size?: integer; sort?: SearchSort; _source?: boolean | SearchSourceFilter | Fields; stored_fields?: Fields; track_scores?: boolean; version?: boolean; seq_no_primary_term?: boolean; } export interface AggregationsTopMetrics { sort: (long | double | string)[]; metrics: Record; } export interface AggregationsTopMetricsAggregate extends AggregationsAggregateBase { top: AggregationsTopMetrics[]; } export interface AggregationsTopMetricsAggregation extends AggregationsMetricAggregationBase { metrics?: AggregationsTopMetricsValue | AggregationsTopMetricsValue[]; size?: integer; sort?: SearchSort; } export interface AggregationsTopMetricsValue { field: Field; } export interface AggregationsValueAggregate extends AggregationsAggregateBase { value: double; value_as_string?: string; } export interface AggregationsValueCountAggregation extends AggregationsFormattableMetricAggregation { } export type AggregationsValueType = | 'string' | 'long' | 'double' | 'number' | 'date' | 'date_nanos' | 'ip' | 'numeric' | 'geo_point' | 'boolean'; export interface AggregationsVariableWidthHistogramAggregation { field?: Field; buckets?: integer; shard_size?: integer; initial_buffer?: integer; } export interface AggregationsWeightedAverageAggregation extends AggregationsAggregation { format?: string; value?: AggregationsWeightedAverageValue; value_type?: AggregationsValueType; weight?: AggregationsWeightedAverageValue; } export interface AggregationsWeightedAverageValue { field?: Field; missing?: double; script?: Script; } export interface AnalysisAsciiFoldingTokenFilter extends AnalysisTokenFilterBase { preserve_original: boolean; } export type AnalysisCharFilter = | AnalysisHtmlStripCharFilter | AnalysisMappingCharFilter | AnalysisPatternReplaceTokenFilter; export interface AnalysisCharFilterBase { type: string; version?: VersionString; } export interface AnalysisCharGroupTokenizer extends AnalysisTokenizerBase { tokenize_on_chars: string[]; } export interface AnalysisCommonGramsTokenFilter extends AnalysisTokenFilterBase { common_words: string[]; common_words_path: string; ignore_case: boolean; query_mode: boolean; } export interface AnalysisCompoundWordTokenFilterBase extends AnalysisTokenFilterBase { hyphenation_patterns_path: string; max_subword_size: integer; min_subword_size: integer; min_word_size: integer; only_longest_match: boolean; word_list: string[]; word_list_path: string; } export interface AnalysisConditionTokenFilter extends AnalysisTokenFilterBase { filter: string[]; script: Script; } export type AnalysisDelimitedPayloadEncoding = 'int' | 'float' | 'identity'; export interface AnalysisDelimitedPayloadTokenFilter extends AnalysisTokenFilterBase { delimiter: string; encoding: AnalysisDelimitedPayloadEncoding; } export type AnalysisEdgeNGramSide = 'front' | 'back'; export interface AnalysisEdgeNGramTokenFilter extends AnalysisTokenFilterBase { max_gram: integer; min_gram: integer; side: AnalysisEdgeNGramSide; } export interface AnalysisEdgeNGramTokenizer extends AnalysisTokenizerBase { custom_token_chars: string; max_gram: integer; min_gram: integer; token_chars: AnalysisTokenChar[]; } export interface AnalysisElisionTokenFilter extends AnalysisTokenFilterBase { articles: string[]; articles_case: boolean; } export interface AnalysisFingerprintTokenFilter extends AnalysisTokenFilterBase { max_output_size: integer; separator: string; } export interface AnalysisHtmlStripCharFilter extends AnalysisCharFilterBase { } export interface AnalysisHunspellTokenFilter extends AnalysisTokenFilterBase { dedup: boolean; dictionary: string; locale: string; longest_only: boolean; } export interface AnalysisHyphenationDecompounderTokenFilter extends AnalysisCompoundWordTokenFilterBase { } export interface AnalysisKStemTokenFilter extends AnalysisTokenFilterBase { } export type AnalysisKeepTypesMode = 'include' | 'exclude'; export interface AnalysisKeepTypesTokenFilter extends AnalysisTokenFilterBase { mode: AnalysisKeepTypesMode; types: string[]; } export interface AnalysisKeepWordsTokenFilter extends AnalysisTokenFilterBase { keep_words: string[]; keep_words_case: boolean; keep_words_path: string; } export interface AnalysisKeywordMarkerTokenFilter extends AnalysisTokenFilterBase { ignore_case: boolean; keywords: string[]; keywords_path: string; keywords_pattern: string; } export interface AnalysisKeywordTokenizer extends AnalysisTokenizerBase { buffer_size: integer; } export interface AnalysisLengthTokenFilter extends AnalysisTokenFilterBase { max: integer; min: integer; } export interface AnalysisLetterTokenizer extends AnalysisTokenizerBase { } export interface AnalysisLimitTokenCountTokenFilter extends AnalysisTokenFilterBase { consume_all_tokens: boolean; max_token_count: integer; } export interface AnalysisLowercaseTokenFilter extends AnalysisTokenFilterBase { language: string; } export interface AnalysisLowercaseTokenizer extends AnalysisTokenizerBase { } export interface AnalysisMappingCharFilter extends AnalysisCharFilterBase { mappings: string[]; mappings_path: string; } export interface AnalysisMultiplexerTokenFilter extends AnalysisTokenFilterBase { filters: string[]; preserve_original: boolean; } export interface AnalysisNGramTokenFilter extends AnalysisTokenFilterBase { max_gram: integer; min_gram: integer; } export interface AnalysisNGramTokenizer extends AnalysisTokenizerBase { custom_token_chars: string; max_gram: integer; min_gram: integer; token_chars: AnalysisTokenChar[]; } export type AnalysisNoriDecompoundMode = 'discard' | 'none' | 'mixed'; export interface AnalysisNoriPartOfSpeechTokenFilter extends AnalysisTokenFilterBase { stoptags: string[]; } export interface AnalysisNoriTokenizer extends AnalysisTokenizerBase { decompound_mode: AnalysisNoriDecompoundMode; discard_punctuation: boolean; user_dictionary: string; user_dictionary_rules: string[]; } export interface AnalysisPathHierarchyTokenizer extends AnalysisTokenizerBase { buffer_size: integer; delimiter: string; replacement: string; reverse: boolean; skip: integer; } export interface AnalysisPatternCaptureTokenFilter extends AnalysisTokenFilterBase { patterns: string[]; preserve_original: boolean; } export interface AnalysisPatternReplaceTokenFilter extends AnalysisTokenFilterBase { flags: string; pattern: string; replacement: string; } export interface AnalysisPorterStemTokenFilter extends AnalysisTokenFilterBase { } export interface AnalysisPredicateTokenFilter extends AnalysisTokenFilterBase { script: Script; } export interface AnalysisRemoveDuplicatesTokenFilter extends AnalysisTokenFilterBase { } export interface AnalysisReverseTokenFilter extends AnalysisTokenFilterBase { } export interface AnalysisShingleTokenFilter extends AnalysisTokenFilterBase { filler_token: string; max_shingle_size: integer; min_shingle_size: integer; output_unigrams: boolean; output_unigrams_if_no_shingles: boolean; token_separator: string; } export type AnalysisSnowballLanguage = | 'Armenian' | 'Basque' | 'Catalan' | 'Danish' | 'Dutch' | 'English' | 'Finnish' | 'French' | 'German' | 'German2' | 'Hungarian' | 'Italian' | 'Kp' | 'Lovins' | 'Norwegian' | 'Porter' | 'Portuguese' | 'Romanian' | 'Russian' | 'Spanish' | 'Swedish' | 'Turkish'; export interface AnalysisSnowballTokenFilter extends AnalysisTokenFilterBase { language: AnalysisSnowballLanguage; } export interface AnalysisStandardTokenizer extends AnalysisTokenizerBase { max_token_length: integer; } export interface AnalysisStemmerOverrideTokenFilter extends AnalysisTokenFilterBase { rules: string[]; rules_path: string; } export interface AnalysisStemmerTokenFilter extends AnalysisTokenFilterBase { language: string; } export interface AnalysisStopTokenFilter extends AnalysisTokenFilterBase { ignore_case?: boolean; remove_trailing?: boolean; stopwords: AnalysisStopWords; stopwords_path?: string; } export type AnalysisStopWords = string | string[]; export type AnalysisSynonymFormat = 'solr' | 'wordnet'; export interface AnalysisSynonymGraphTokenFilter extends AnalysisTokenFilterBase { expand: boolean; format: AnalysisSynonymFormat; lenient: boolean; synonyms: string[]; synonyms_path: string; tokenizer: string; updateable: boolean; } export interface AnalysisSynonymTokenFilter extends AnalysisTokenFilterBase { expand: boolean; format: AnalysisSynonymFormat; lenient: boolean; synonyms: string[]; synonyms_path: string; tokenizer: string; updateable: boolean; } export type AnalysisTokenChar = | 'letter' | 'digit' | 'whitespace' | 'punctuation' | 'symbol' | 'custom'; export type AnalysisTokenFilter = | AnalysisAsciiFoldingTokenFilter | AnalysisCommonGramsTokenFilter | AnalysisConditionTokenFilter | AnalysisDelimitedPayloadTokenFilter | AnalysisEdgeNGramTokenFilter | AnalysisElisionTokenFilter | AnalysisFingerprintTokenFilter | AnalysisHunspellTokenFilter | AnalysisHyphenationDecompounderTokenFilter | AnalysisKeepTypesTokenFilter | AnalysisKeepWordsTokenFilter | AnalysisKeywordMarkerTokenFilter | AnalysisKStemTokenFilter | AnalysisLengthTokenFilter | AnalysisLimitTokenCountTokenFilter | AnalysisLowercaseTokenFilter | AnalysisMultiplexerTokenFilter | AnalysisNGramTokenFilter | AnalysisNoriPartOfSpeechTokenFilter | AnalysisPatternCaptureTokenFilter | AnalysisPatternReplaceTokenFilter | AnalysisPorterStemTokenFilter | AnalysisPredicateTokenFilter | AnalysisRemoveDuplicatesTokenFilter | AnalysisReverseTokenFilter | AnalysisShingleTokenFilter | AnalysisSnowballTokenFilter | AnalysisStemmerOverrideTokenFilter | AnalysisStemmerTokenFilter | AnalysisStopTokenFilter | AnalysisSynonymGraphTokenFilter | AnalysisSynonymTokenFilter | AnalysisTrimTokenFilter | AnalysisTruncateTokenFilter | AnalysisUniqueTokenFilter | AnalysisUppercaseTokenFilter | AnalysisWordDelimiterGraphTokenFilter | AnalysisWordDelimiterTokenFilter; export interface AnalysisTokenFilterBase { type: string; version?: VersionString; } export type AnalysisTokenizer = | AnalysisCharGroupTokenizer | AnalysisEdgeNGramTokenizer | AnalysisKeywordTokenizer | AnalysisLetterTokenizer | AnalysisLowercaseTokenizer | AnalysisNGramTokenizer | AnalysisNoriTokenizer | AnalysisPathHierarchyTokenizer | AnalysisStandardTokenizer | AnalysisUaxEmailUrlTokenizer | AnalysisWhitespaceTokenizer; export interface AnalysisTokenizerBase { type: string; version?: VersionString; } export interface AnalysisTrimTokenFilter extends AnalysisTokenFilterBase { } export interface AnalysisTruncateTokenFilter extends AnalysisTokenFilterBase { length: integer; } export interface AnalysisUaxEmailUrlTokenizer extends AnalysisTokenizerBase { max_token_length: integer; } export interface AnalysisUniqueTokenFilter extends AnalysisTokenFilterBase { only_on_same_position: boolean; } export interface AnalysisUppercaseTokenFilter extends AnalysisTokenFilterBase { } export interface AnalysisWhitespaceTokenizer extends AnalysisTokenizerBase { max_token_length: integer; } export interface AnalysisWordDelimiterGraphTokenFilter extends AnalysisTokenFilterBase { adjust_offsets: boolean; catenate_all: boolean; catenate_numbers: boolean; catenate_words: boolean; generate_number_parts: boolean; generate_word_parts: boolean; preserve_original: boolean; protected_words: string[]; protected_words_path: string; split_on_case_change: boolean; split_on_numerics: boolean; stem_english_possessive: boolean; type_table: string[]; type_table_path: string; } export interface AnalysisWordDelimiterTokenFilter extends AnalysisTokenFilterBase { catenate_all: boolean; catenate_numbers: boolean; catenate_words: boolean; generate_number_parts: boolean; generate_word_parts: boolean; preserve_original: boolean; protected_words: string[]; protected_words_path: string; split_on_case_change: boolean; split_on_numerics: boolean; stem_english_possessive: boolean; type_table: string[]; type_table_path: string; } export interface MappingAllField { analyzer: string; enabled: boolean; omit_norms: boolean; search_analyzer: string; similarity: string; store: boolean; store_term_vector_offsets: boolean; store_term_vector_payloads: boolean; store_term_vector_positions: boolean; store_term_vectors: boolean; } export interface MappingBinaryProperty extends MappingDocValuesPropertyBase { type: 'binary'; } export interface MappingBooleanProperty extends MappingDocValuesPropertyBase { boost?: double; fielddata?: IndicesNumericFielddata; index?: boolean; null_value?: boolean; type: 'boolean'; } export interface MappingCompletionProperty extends MappingDocValuesPropertyBase { analyzer?: string; contexts?: MappingSuggestContext[]; max_input_length?: integer; preserve_position_increments?: boolean; preserve_separators?: boolean; search_analyzer?: string; type: 'completion'; } export interface MappingConstantKeywordProperty extends MappingPropertyBase { value?: any; type: 'constant_keyword'; } export type MappingCoreProperty = | MappingObjectProperty | MappingNestedProperty | MappingSearchAsYouTypeProperty | MappingTextProperty | MappingDocValuesProperty; export interface MappingCorePropertyBase extends MappingPropertyBase { copy_to?: Fields; similarity?: string; store?: boolean; } export interface MappingDateNanosProperty extends MappingDocValuesPropertyBase { boost?: double; format?: string; ignore_malformed?: boolean; index?: boolean; null_value?: DateString; precision_step?: integer; type: 'date_nanos'; } export interface MappingDateProperty extends MappingDocValuesPropertyBase { boost?: double; fielddata?: IndicesNumericFielddata; format?: string; ignore_malformed?: boolean; index?: boolean; null_value?: DateString; precision_step?: integer; type: 'date'; } export interface MappingDateRangeProperty extends MappingRangePropertyBase { format?: string; type: 'date_range'; } export type MappingDocValuesProperty = | MappingBinaryProperty | MappingBooleanProperty | MappingDateProperty | MappingDateNanosProperty | MappingKeywordProperty | MappingNumberProperty | MappingRangeProperty | MappingGeoPointProperty | MappingGeoShapeProperty | MappingCompletionProperty | MappingGenericProperty | MappingIpProperty | MappingMurmur3HashProperty | MappingShapeProperty | MappingTokenCountProperty | MappingVersionProperty | MappingWildcardProperty | MappingPointProperty; export interface MappingDocValuesPropertyBase extends MappingCorePropertyBase { doc_values?: boolean; } export interface MappingDoubleRangeProperty extends MappingRangePropertyBase { type: 'double_range'; } export type MappingDynamicMapping = 'strict' | 'runtime' | 'true' | 'false'; export interface MappingDynamicTemplate { mapping?: MappingPropertyBase; match?: string; match_mapping_type?: string; match_pattern?: MappingMatchType; path_match?: string; path_unmatch?: string; unmatch?: string; } export interface MappingFieldAliasProperty extends MappingPropertyBase { path?: Field; type: 'alias'; } export interface MappingFieldMapping { } export interface MappingFieldNamesField { enabled: boolean; } export type MappingFieldType = | 'none' | 'geo_point' | 'geo_shape' | 'ip' | 'binary' | 'keyword' | 'text' | 'search_as_you_type' | 'date' | 'date_nanos' | 'boolean' | 'completion' | 'nested' | 'object' | 'murmur3' | 'token_count' | 'percolator' | 'integer' | 'long' | 'short' | 'byte' | 'float' | 'half_float' | 'scaled_float' | 'double' | 'integer_range' | 'float_range' | 'long_range' | 'double_range' | 'date_range' | 'ip_range' | 'alias' | 'join' | 'rank_feature' | 'rank_features' | 'flattened' | 'shape' | 'histogram' | 'constant_keyword'; export interface MappingFlattenedProperty extends MappingPropertyBase { boost?: double; depth_limit?: integer; doc_values?: boolean; eager_global_ordinals?: boolean; index?: boolean; index_options?: MappingIndexOptions; null_value?: string; similarity?: string; split_queries_on_whitespace?: boolean; type: 'flattened'; } export interface MappingFloatRangeProperty extends MappingRangePropertyBase { type: 'float_range'; } export interface MappingGenericProperty extends MappingDocValuesPropertyBase { analyzer?: string; boost?: double; fielddata?: IndicesStringFielddata; ignore_malformed?: boolean; index?: boolean; index_options?: MappingIndexOptions; norms?: boolean; null_value?: string; position_increment_gap?: integer; search_analyzer?: string; term_vector?: MappingTermVectorOption; type: string; } export type MappingGeoOrientation = | 'right' | 'RIGHT' | 'counterclockwise' | 'COUNTERCLOCKWISE' | 'ccw' | 'CCW' | 'left' | 'LEFT' | 'clockwise' | 'CLOCKWISE' | 'cw' | 'CW'; export interface MappingGeoPointProperty extends MappingDocValuesPropertyBase { ignore_malformed?: boolean; ignore_z_value?: boolean; null_value?: QueryDslGeoLocation; type: 'geo_point'; } export interface MappingGeoShapeProperty extends MappingDocValuesPropertyBase { coerce?: boolean; ignore_malformed?: boolean; ignore_z_value?: boolean; orientation?: MappingGeoOrientation; strategy?: MappingGeoStrategy; type: 'geo_shape'; } export type MappingGeoStrategy = 'recursive' | 'term'; export interface MappingHistogramProperty extends MappingPropertyBase { ignore_malformed?: boolean; type: 'histogram'; } export interface MappingIndexField { enabled: boolean; } export type MappingIndexOptions = 'docs' | 'freqs' | 'positions' | 'offsets'; export interface MappingIntegerRangeProperty extends MappingRangePropertyBase { type: 'integer_range'; } export interface MappingIpProperty extends MappingDocValuesPropertyBase { boost?: double; index?: boolean; null_value?: string; type: 'ip'; } export interface MappingIpRangeProperty extends MappingRangePropertyBase { type: 'ip_range'; } export interface MappingJoinProperty extends MappingPropertyBase { relations?: Record; type: 'join'; } export interface MappingKeywordProperty extends MappingDocValuesPropertyBase { boost?: double; eager_global_ordinals?: boolean; index?: boolean; index_options?: MappingIndexOptions; normalizer?: string; norms?: boolean; null_value?: string; split_queries_on_whitespace?: boolean; type: 'keyword'; } export interface MappingLongRangeProperty extends MappingRangePropertyBase { type: 'long_range'; } export type MappingMatchType = 'simple' | 'regex'; export interface MappingMurmur3HashProperty extends MappingDocValuesPropertyBase { type: 'murmur3'; } export interface MappingNestedProperty extends MappingCorePropertyBase { enabled?: boolean; include_in_parent?: boolean; include_in_root?: boolean; type: 'nested'; } export interface MappingNumberProperty extends MappingDocValuesPropertyBase { boost?: double; coerce?: boolean; fielddata?: IndicesNumericFielddata; ignore_malformed?: boolean; index?: boolean; null_value?: double; scaling_factor?: double; type: MappingNumberType; } export type MappingNumberType = | 'float' | 'half_float' | 'scaled_float' | 'double' | 'integer' | 'long' | 'short' | 'byte' | 'unsigned_long'; export interface MappingObjectProperty extends MappingCorePropertyBase { enabled?: boolean; type?: 'object'; } export interface MappingPercolatorProperty extends MappingPropertyBase { type: 'percolator'; } export interface MappingPointProperty extends MappingDocValuesPropertyBase { ignore_malformed?: boolean; ignore_z_value?: boolean; null_value?: string; type: 'point'; } export type MappingProperty = | MappingFlattenedProperty | MappingJoinProperty | MappingPercolatorProperty | MappingRankFeatureProperty | MappingRankFeaturesProperty | MappingConstantKeywordProperty | MappingFieldAliasProperty | MappingHistogramProperty | MappingCoreProperty; export interface MappingPropertyBase { local_metadata?: Metadata; meta?: Record; name?: PropertyName; properties?: Record; ignore_above?: integer; dynamic?: boolean | MappingDynamicMapping; fields?: Record; } export type MappingRangeProperty = | MappingLongRangeProperty | MappingIpRangeProperty | MappingIntegerRangeProperty | MappingFloatRangeProperty | MappingDoubleRangeProperty | MappingDateRangeProperty; export interface MappingRangePropertyBase extends MappingDocValuesPropertyBase { boost?: double; coerce?: boolean; index?: boolean; } export interface MappingRankFeatureProperty extends MappingPropertyBase { positive_score_impact?: boolean; type: 'rank_feature'; } export interface MappingRankFeaturesProperty extends MappingPropertyBase { type: 'rank_features'; } export interface MappingRoutingField { required: boolean; } export interface MappingRuntimeField { format?: string; script?: Script; type: MappingRuntimeFieldType; } export type MappingRuntimeFieldType = | 'boolean' | 'date' | 'double' | 'geo_point' | 'ip' | 'keyword' | 'long'; export type MappingRuntimeFields = Record; export interface MappingSearchAsYouTypeProperty extends MappingCorePropertyBase { analyzer?: string; index?: boolean; index_options?: MappingIndexOptions; max_shingle_size?: integer; norms?: boolean; search_analyzer?: string; search_quote_analyzer?: string; term_vector?: MappingTermVectorOption; type: 'search_as_you_type'; } export type MappingShapeOrientation = | 'right' | 'counterclockwise' | 'ccw' | 'left' | 'clockwise' | 'cw'; export interface MappingShapeProperty extends MappingDocValuesPropertyBase { coerce?: boolean; ignore_malformed?: boolean; ignore_z_value?: boolean; orientation?: MappingShapeOrientation; type: 'shape'; } export interface MappingSizeField { enabled: boolean; } export interface MappingSourceField { compress?: boolean; compress_threshold?: string; enabled: boolean; excludes?: string[]; includes?: string[]; } export interface MappingSuggestContext { name: Name; path?: Field; type: string; precision?: integer; } export type MappingTermVectorOption = | 'no' | 'yes' | 'with_offsets' | 'with_positions' | 'with_positions_offsets' | 'with_positions_offsets_payloads'; export interface MappingTextIndexPrefixes { max_chars: integer; min_chars: integer; } export interface MappingTextProperty extends MappingCorePropertyBase { analyzer?: string; boost?: double; eager_global_ordinals?: boolean; fielddata?: boolean; fielddata_frequency_filter?: IndicesFielddataFrequencyFilter; index?: boolean; index_options?: MappingIndexOptions; index_phrases?: boolean; index_prefixes?: MappingTextIndexPrefixes; norms?: boolean; position_increment_gap?: integer; search_analyzer?: string; search_quote_analyzer?: string; term_vector?: MappingTermVectorOption; type: 'text'; } export interface MappingTokenCountProperty extends MappingDocValuesPropertyBase { analyzer?: string; boost?: double; index?: boolean; null_value?: double; enable_position_increments?: boolean; type: 'token_count'; } export interface MappingTypeMapping { all_field?: MappingAllField; date_detection?: boolean; dynamic?: boolean | MappingDynamicMapping; dynamic_date_formats?: string[]; dynamic_templates?: | Record | Record[]; _field_names?: MappingFieldNamesField; index_field?: MappingIndexField; _meta?: Metadata; numeric_detection?: boolean; properties?: Record; _routing?: MappingRoutingField; _size?: MappingSizeField; _source?: MappingSourceField; runtime?: Record; } export interface MappingVersionProperty extends MappingDocValuesPropertyBase { type: 'version'; } export interface MappingWildcardProperty extends MappingDocValuesPropertyBase { type: 'wildcard'; } export interface QueryDslBoolQuery extends QueryDslQueryBase { filter?: QueryDslQueryContainer | QueryDslQueryContainer[]; minimum_should_match?: MinimumShouldMatch; must?: QueryDslQueryContainer | QueryDslQueryContainer[]; must_not?: QueryDslQueryContainer | QueryDslQueryContainer[]; should?: QueryDslQueryContainer | QueryDslQueryContainer[]; } export interface QueryDslBoostingQuery extends QueryDslQueryBase { negative_boost?: double; negative?: QueryDslQueryContainer; positive?: QueryDslQueryContainer; } export interface QueryDslBoundingBox { bottom_right?: QueryDslGeoLocation; top_left?: QueryDslGeoLocation; wkt?: string; } export type QueryDslChildScoreMode = 'none' | 'avg' | 'sum' | 'max' | 'min'; export interface QueryDslCombinedFieldsQuery { query: string; fields: Field[]; operator?: string; } export interface QueryDslCommonTermsQuery extends QueryDslQueryBase { analyzer?: string; cutoff_frequency?: double; high_freq_operator?: QueryDslOperator; low_freq_operator?: QueryDslOperator; minimum_should_match?: MinimumShouldMatch; query?: string; } export interface QueryDslConstantScoreQuery extends QueryDslQueryBase { filter?: QueryDslQueryContainer; } export interface QueryDslDateDecayFunctionKeys extends QueryDslDecayFunctionBase { } export type QueryDslDateDecayFunction = | QueryDslDateDecayFunctionKeys | { [property: string]: QueryDslDecayPlacement }; export type QueryDslDecayFunction = | QueryDslDateDecayFunction | QueryDslNumericDecayFunction | QueryDslGeoDecayFunction; export interface QueryDslDecayFunctionBase extends QueryDslScoreFunctionBase { multi_value_mode?: QueryDslMultiValueMode; } export interface QueryDslDecayPlacement { decay?: double; offset?: TScale; scale?: TScale; origin?: TOrigin; } export interface QueryDslDisMaxQuery extends QueryDslQueryBase { queries?: QueryDslQueryContainer[]; tie_breaker?: double; } export interface QueryDslDistanceFeatureQuery extends QueryDslQueryBase { origin?: number[] | QueryDslGeoCoordinate | DateMath; pivot?: Distance | Time; field?: Field; } export interface QueryDslExistsQuery extends QueryDslQueryBase { field?: Field; } export interface QueryDslFieldLookup { id?: Id; index?: IndexName; path?: Field; routing?: Routing; } export type QueryDslFieldValueFactorModifier = | 'none' | 'log' | 'log1p' | 'log2p' | 'ln' | 'ln1p' | 'ln2p' | 'square' | 'sqrt' | 'reciprocal'; export interface QueryDslFieldValueFactorScoreFunction extends QueryDslScoreFunctionBase { field: Field; factor?: double; missing?: double; modifier?: QueryDslFieldValueFactorModifier; } export type QueryDslFunctionBoostMode = 'multiply' | 'replace' | 'sum' | 'avg' | 'max' | 'min'; export interface QueryDslFunctionScoreContainer { exp?: QueryDslDecayFunction; gauss?: QueryDslDecayFunction; linear?: QueryDslDecayFunction; field_value_factor?: QueryDslFieldValueFactorScoreFunction; random_score?: QueryDslRandomScoreFunction; script_score?: QueryDslScriptScoreFunction; filter?: QueryDslQueryContainer; weight?: double; } export type QueryDslFunctionScoreMode = 'multiply' | 'sum' | 'avg' | 'first' | 'max' | 'min'; export interface QueryDslFunctionScoreQuery extends QueryDslQueryBase { boost_mode?: QueryDslFunctionBoostMode; functions?: QueryDslFunctionScoreContainer[]; max_boost?: double; min_score?: double; query?: QueryDslQueryContainer; score_mode?: QueryDslFunctionScoreMode; } export interface QueryDslFuzzyQuery extends QueryDslQueryBase { max_expansions?: integer; prefix_length?: integer; rewrite?: MultiTermQueryRewrite; transpositions?: boolean; fuzziness?: Fuzziness; value: any; } export interface QueryDslGeoBoundingBoxQuery extends QueryDslQueryBase { bounding_box?: QueryDslBoundingBox; type?: QueryDslGeoExecution; validation_method?: QueryDslGeoValidationMethod; top_left?: LatLon; bottom_right?: LatLon; } export type QueryDslGeoCoordinate = string | double[] | QueryDslThreeDimensionalPoint; export interface QueryDslGeoDecayFunctionKeys extends QueryDslDecayFunctionBase { } export type QueryDslGeoDecayFunction = | QueryDslGeoDecayFunctionKeys | { [property: string]: QueryDslDecayPlacement }; export interface QueryDslGeoDistanceQueryKeys extends QueryDslQueryBase { distance?: Distance; distance_type?: GeoDistanceType; validation_method?: QueryDslGeoValidationMethod; } export type QueryDslGeoDistanceQuery = | QueryDslGeoDistanceQueryKeys | { [property: string]: QueryDslGeoLocation }; export type QueryDslGeoExecution = 'memory' | 'indexed'; export type QueryDslGeoLocation = string | double[] | QueryDslTwoDimensionalPoint; export interface QueryDslGeoPolygonQuery extends QueryDslQueryBase { points?: QueryDslGeoLocation[]; validation_method?: QueryDslGeoValidationMethod; } export interface QueryDslGeoShape { type?: string; } export interface QueryDslGeoShapeQuery extends QueryDslQueryBase { ignore_unmapped?: boolean; indexed_shape?: QueryDslFieldLookup; relation?: GeoShapeRelation; shape?: QueryDslGeoShape; } export type QueryDslGeoValidationMethod = 'coerce' | 'ignore_malformed' | 'strict'; export interface QueryDslHasChildQuery extends QueryDslQueryBase { ignore_unmapped?: boolean; inner_hits?: SearchInnerHits; max_children?: integer; min_children?: integer; query?: QueryDslQueryContainer; score_mode?: QueryDslChildScoreMode; type?: RelationName; } export interface QueryDslHasParentQuery extends QueryDslQueryBase { ignore_unmapped?: boolean; inner_hits?: SearchInnerHits; parent_type?: RelationName; query?: QueryDslQueryContainer; score?: boolean; } export interface QueryDslIdsQuery extends QueryDslQueryBase { values?: Id[] | long[]; } export interface QueryDslIntervalsAllOf { intervals?: QueryDslIntervalsContainer[]; max_gaps?: integer; ordered?: boolean; filter?: QueryDslIntervalsFilter; } export interface QueryDslIntervalsAnyOf { intervals?: QueryDslIntervalsContainer[]; filter?: QueryDslIntervalsFilter; } export interface QueryDslIntervalsContainer { all_of?: QueryDslIntervalsAllOf; any_of?: QueryDslIntervalsAnyOf; fuzzy?: QueryDslIntervalsFuzzy; match?: QueryDslIntervalsMatch; prefix?: QueryDslIntervalsPrefix; wildcard?: QueryDslIntervalsWildcard; } export interface QueryDslIntervalsFilter { after?: QueryDslIntervalsContainer; before?: QueryDslIntervalsContainer; contained_by?: QueryDslIntervalsContainer; containing?: QueryDslIntervalsContainer; not_contained_by?: QueryDslIntervalsContainer; not_containing?: QueryDslIntervalsContainer; not_overlapping?: QueryDslIntervalsContainer; overlapping?: QueryDslIntervalsContainer; script?: Script; } export interface QueryDslIntervalsFuzzy { analyzer?: string; fuzziness?: Fuzziness; prefix_length?: integer; term?: string; transpositions?: boolean; use_field?: Field; } export interface QueryDslIntervalsMatch { analyzer?: string; max_gaps?: integer; ordered?: boolean; query?: string; use_field?: Field; filter?: QueryDslIntervalsFilter; } export interface QueryDslIntervalsPrefix { analyzer?: string; prefix?: string; use_field?: Field; } export interface QueryDslIntervalsQuery extends QueryDslQueryBase { all_of?: QueryDslIntervalsAllOf; any_of?: QueryDslIntervalsAnyOf; fuzzy?: QueryDslIntervalsFuzzy; match?: QueryDslIntervalsMatch; prefix?: QueryDslIntervalsPrefix; wildcard?: QueryDslIntervalsWildcard; } export interface QueryDslIntervalsWildcard { analyzer?: string; pattern?: string; use_field?: Field; } export type QueryDslLike = string | QueryDslLikeDocument; export interface QueryDslLikeDocument { doc?: any; fields?: Fields; _id?: Id | number; _type?: Type; _index?: IndexName; per_field_analyzer?: Record; routing?: Routing; } export interface QueryDslMatchAllQuery extends QueryDslQueryBase { norm_field?: string; } export interface QueryDslMatchBoolPrefixQuery extends QueryDslQueryBase { analyzer?: string; fuzziness?: Fuzziness; fuzzy_rewrite?: MultiTermQueryRewrite; fuzzy_transpositions?: boolean; max_expansions?: integer; minimum_should_match?: MinimumShouldMatch; operator?: QueryDslOperator; prefix_length?: integer; query?: string; } export interface QueryDslMatchNoneQuery extends QueryDslQueryBase { } export interface QueryDslMatchPhrasePrefixQuery extends QueryDslQueryBase { analyzer?: string; max_expansions?: integer; query?: string; slop?: integer; zero_terms_query?: QueryDslZeroTermsQuery; } export interface QueryDslMatchPhraseQuery extends QueryDslQueryBase { analyzer?: string; query?: string; slop?: integer; } export interface QueryDslMatchQuery extends QueryDslQueryBase { analyzer?: string; auto_generate_synonyms_phrase_query?: boolean; cutoff_frequency?: double; fuzziness?: Fuzziness; fuzzy_rewrite?: MultiTermQueryRewrite; fuzzy_transpositions?: boolean; lenient?: boolean; max_expansions?: integer; minimum_should_match?: MinimumShouldMatch; operator?: QueryDslOperator; prefix_length?: integer; query?: string | float | boolean; zero_terms_query?: QueryDslZeroTermsQuery; } export interface QueryDslMoreLikeThisQuery extends QueryDslQueryBase { analyzer?: string; boost_terms?: double; fields?: Fields; include?: boolean; like?: QueryDslLike | QueryDslLike[]; max_doc_freq?: integer; max_query_terms?: integer; max_word_length?: integer; min_doc_freq?: integer; minimum_should_match?: MinimumShouldMatch; min_term_freq?: integer; min_word_length?: integer; per_field_analyzer?: Record; routing?: Routing; stop_words?: AnalysisStopWords; unlike?: QueryDslLike | QueryDslLike[]; version?: VersionNumber; version_type?: VersionType; } export interface QueryDslMultiMatchQuery extends QueryDslQueryBase { analyzer?: string; auto_generate_synonyms_phrase_query?: boolean; cutoff_frequency?: double; fields?: Fields; fuzziness?: Fuzziness; fuzzy_rewrite?: MultiTermQueryRewrite; fuzzy_transpositions?: boolean; lenient?: boolean; max_expansions?: integer; minimum_should_match?: MinimumShouldMatch; operator?: QueryDslOperator; prefix_length?: integer; query?: string; slop?: integer; tie_breaker?: double; type?: QueryDslTextQueryType; use_dis_max?: boolean; zero_terms_query?: QueryDslZeroTermsQuery; } export type QueryDslMultiValueMode = 'min' | 'max' | 'avg' | 'sum'; export interface QueryDslNamedQueryKeys { boost?: float; _name?: string; ignore_unmapped?: boolean; } export type QueryDslNamedQuery = | QueryDslNamedQueryKeys | { [property: string]: TQuery }; export interface QueryDslNestedQuery extends QueryDslQueryBase { ignore_unmapped?: boolean; inner_hits?: SearchInnerHits; path?: Field; query?: QueryDslQueryContainer; score_mode?: QueryDslNestedScoreMode; } export type QueryDslNestedScoreMode = 'avg' | 'sum' | 'min' | 'max' | 'none'; export interface QueryDslNumericDecayFunctionKeys extends QueryDslDecayFunctionBase { } export type QueryDslNumericDecayFunction = | QueryDslNumericDecayFunctionKeys | { [property: string]: QueryDslDecayPlacement }; export type QueryDslOperator = 'and' | 'or' | 'AND' | 'OR'; export interface QueryDslParentIdQuery extends QueryDslQueryBase { id?: Id; ignore_unmapped?: boolean; type?: RelationName; } export interface QueryDslPercolateQuery extends QueryDslQueryBase { document?: any; documents?: any[]; field?: Field; id?: Id; index?: IndexName; preference?: string; routing?: Routing; version?: VersionNumber; } export interface QueryDslPinnedQuery extends QueryDslQueryBase { ids?: Id[] | long[]; organic?: QueryDslQueryContainer; } export interface QueryDslPrefixQuery extends QueryDslQueryBase { rewrite?: MultiTermQueryRewrite; value: string; } export interface QueryDslQueryBase { boost?: float; _name?: string; } export interface QueryDslQueryContainer { bool?: QueryDslBoolQuery; boosting?: QueryDslBoostingQuery; common?: Record; combined_fields?: QueryDslCombinedFieldsQuery; constant_score?: QueryDslConstantScoreQuery; dis_max?: QueryDslDisMaxQuery; distance_feature?: | Record | QueryDslDistanceFeatureQuery; exists?: QueryDslExistsQuery; function_score?: QueryDslFunctionScoreQuery; fuzzy?: Record; geo_bounding_box?: QueryDslNamedQuery; geo_distance?: QueryDslGeoDistanceQuery; geo_polygon?: QueryDslNamedQuery; geo_shape?: QueryDslNamedQuery; has_child?: QueryDslHasChildQuery; has_parent?: QueryDslHasParentQuery; ids?: QueryDslIdsQuery; intervals?: QueryDslNamedQuery; match?: QueryDslNamedQuery; match_all?: QueryDslMatchAllQuery; match_bool_prefix?: QueryDslNamedQuery; match_none?: QueryDslMatchNoneQuery; match_phrase?: QueryDslNamedQuery; match_phrase_prefix?: QueryDslNamedQuery; more_like_this?: QueryDslMoreLikeThisQuery; multi_match?: QueryDslMultiMatchQuery; nested?: QueryDslNestedQuery; parent_id?: QueryDslParentIdQuery; percolate?: QueryDslPercolateQuery; pinned?: QueryDslPinnedQuery; prefix?: QueryDslNamedQuery; query_string?: QueryDslQueryStringQuery; range?: QueryDslNamedQuery; rank_feature?: QueryDslNamedQuery; regexp?: QueryDslNamedQuery; script?: QueryDslScriptQuery; script_score?: QueryDslScriptScoreQuery; shape?: QueryDslNamedQuery; simple_query_string?: QueryDslSimpleQueryStringQuery; span_containing?: QueryDslSpanContainingQuery; field_masking_span?: QueryDslSpanFieldMaskingQuery; span_first?: QueryDslSpanFirstQuery; span_multi?: QueryDslSpanMultiTermQuery; span_near?: QueryDslSpanNearQuery; span_not?: QueryDslSpanNotQuery; span_or?: QueryDslSpanOrQuery; span_term?: QueryDslNamedQuery; span_within?: QueryDslSpanWithinQuery; template?: QueryDslQueryTemplate; term?: QueryDslNamedQuery; terms?: QueryDslNamedQuery; terms_set?: QueryDslNamedQuery; wildcard?: QueryDslNamedQuery; type?: QueryDslTypeQuery; } export interface QueryDslQueryStringQuery extends QueryDslQueryBase { allow_leading_wildcard?: boolean; analyzer?: string; analyze_wildcard?: boolean; auto_generate_synonyms_phrase_query?: boolean; default_field?: Field; default_operator?: QueryDslOperator; enable_position_increments?: boolean; escape?: boolean; fields?: Fields; fuzziness?: Fuzziness; fuzzy_max_expansions?: integer; fuzzy_prefix_length?: integer; fuzzy_rewrite?: MultiTermQueryRewrite; fuzzy_transpositions?: boolean; lenient?: boolean; max_determinized_states?: integer; minimum_should_match?: MinimumShouldMatch; phrase_slop?: double; query?: string; quote_analyzer?: string; quote_field_suffix?: string; rewrite?: MultiTermQueryRewrite; tie_breaker?: double; time_zone?: string; type?: QueryDslTextQueryType; } export interface QueryDslQueryTemplate { source: string; } export interface QueryDslRandomScoreFunction extends QueryDslScoreFunctionBase { field?: Field; seed?: long | string; } export interface QueryDslRangeQuery extends QueryDslQueryBase { gt?: double | DateMath; gte?: double | DateMath; lt?: double | DateMath; lte?: double | DateMath; relation?: QueryDslRangeRelation; time_zone?: string; from?: double | DateMath; to?: double | DateMath; } export type QueryDslRangeRelation = 'within' | 'contains' | 'intersects'; export interface QueryDslRankFeatureFunction { } export interface QueryDslRankFeatureQuery extends QueryDslQueryBase { function?: QueryDslRankFeatureFunction; } export interface QueryDslRegexpQuery extends QueryDslQueryBase { flags?: string; max_determinized_states?: integer; value?: string; } export interface QueryDslScoreFunctionBase { filter?: QueryDslQueryContainer; weight?: double; } export interface QueryDslScriptQuery extends QueryDslQueryBase { script?: Script; } export interface QueryDslScriptScoreFunction extends QueryDslScoreFunctionBase { script: Script; } export interface QueryDslScriptScoreQuery extends QueryDslQueryBase { query?: QueryDslQueryContainer; script?: Script; } export interface QueryDslShapeQuery extends QueryDslQueryBase { ignore_unmapped?: boolean; indexed_shape?: QueryDslFieldLookup; relation?: ShapeRelation; shape?: QueryDslGeoShape; } export type QueryDslSimpleQueryStringFlags = | 'NONE' | 'AND' | 'OR' | 'NOT' | 'PREFIX' | 'PHRASE' | 'PRECEDENCE' | 'ESCAPE' | 'WHITESPACE' | 'FUZZY' | 'NEAR' | 'SLOP' | 'ALL'; export interface QueryDslSimpleQueryStringQuery extends QueryDslQueryBase { analyzer?: string; analyze_wildcard?: boolean; auto_generate_synonyms_phrase_query?: boolean; default_operator?: QueryDslOperator; fields?: Fields; flags?: QueryDslSimpleQueryStringFlags | string; fuzzy_max_expansions?: integer; fuzzy_prefix_length?: integer; fuzzy_transpositions?: boolean; lenient?: boolean; minimum_should_match?: MinimumShouldMatch; query?: string; quote_field_suffix?: string; } export interface QueryDslSpanContainingQuery extends QueryDslQueryBase { big?: QueryDslSpanQuery; little?: QueryDslSpanQuery; } export interface QueryDslSpanFieldMaskingQuery extends QueryDslQueryBase { field?: Field; query?: QueryDslSpanQuery; } export interface QueryDslSpanFirstQuery extends QueryDslQueryBase { end?: integer; match?: QueryDslSpanQuery; } export interface QueryDslSpanGapQuery extends QueryDslQueryBase { field?: Field; width?: integer; } export interface QueryDslSpanMultiTermQuery extends QueryDslQueryBase { match?: QueryDslQueryContainer; } export interface QueryDslSpanNearQuery extends QueryDslQueryBase { clauses?: QueryDslSpanQuery[]; in_order?: boolean; slop?: integer; } export interface QueryDslSpanNotQuery extends QueryDslQueryBase { dist?: integer; exclude?: QueryDslSpanQuery; include?: QueryDslSpanQuery; post?: integer; pre?: integer; } export interface QueryDslSpanOrQuery extends QueryDslQueryBase { clauses?: QueryDslSpanQuery[]; } export interface QueryDslSpanQuery extends QueryDslQueryBase { span_containing?: QueryDslNamedQuery; field_masking_span?: QueryDslNamedQuery; span_first?: QueryDslNamedQuery; span_gap?: QueryDslNamedQuery; span_multi?: QueryDslSpanMultiTermQuery; span_near?: QueryDslNamedQuery; span_not?: QueryDslNamedQuery; span_or?: QueryDslNamedQuery; span_term?: QueryDslNamedQuery; span_within?: QueryDslNamedQuery; } export interface QueryDslSpanTermQuery extends QueryDslQueryBase { value: string; } export interface QueryDslSpanWithinQuery extends QueryDslQueryBase { big?: QueryDslSpanQuery; little?: QueryDslSpanQuery; } export interface QueryDslTermQuery extends QueryDslQueryBase { value?: string | float | boolean; } export interface QueryDslTermsQuery extends QueryDslQueryBase { terms?: string[]; index?: IndexName; id?: Id; path?: string; routing?: Routing; } export interface QueryDslTermsSetQuery extends QueryDslQueryBase { minimum_should_match_field?: Field; minimum_should_match_script?: Script; terms?: string[]; } export type QueryDslTextQueryType = | 'best_fields' | 'most_fields' | 'cross_fields' | 'phrase' | 'phrase_prefix' | 'bool_prefix'; export interface QueryDslThreeDimensionalPoint { lat: double; lon: double; z?: double; } export interface QueryDslTwoDimensionalPoint { lat: double; lon: double; } export interface QueryDslTypeQuery extends QueryDslQueryBase { value: string; } export interface QueryDslWildcardQuery extends QueryDslQueryBase { rewrite?: MultiTermQueryRewrite; value: string; } export type QueryDslZeroTermsQuery = 'all' | 'none'; export interface CatCatRequestBase extends RequestBase, SpecUtilsCommonCatQueryParameters { } export interface CatAliasesAliasesRecord { alias?: string; a?: string; index?: IndexName; i?: IndexName; idx?: IndexName; filter?: string; f?: string; fi?: string; 'routing.index'?: string; ri?: string; routingIndex?: string; 'routing.search'?: string; rs?: string; routingSearch?: string; is_write_index?: string; w?: string; isWriteIndex?: string; } export interface CatAliasesRequest extends CatCatRequestBase { name?: Names; expand_wildcards?: ExpandWildcards; } export type CatAliasesResponse = CatAliasesAliasesRecord[]; export interface CatAllocationAllocationRecord { shards?: string; s?: string; 'disk.indices'?: ByteSize; di?: ByteSize; diskIndices?: ByteSize; 'disk.used'?: ByteSize; du?: ByteSize; diskUsed?: ByteSize; 'disk.avail'?: ByteSize; da?: ByteSize; diskAvail?: ByteSize; 'disk.total'?: ByteSize; dt?: ByteSize; diskTotal?: ByteSize; 'disk.percent'?: Percentage; dp?: Percentage; diskPercent?: Percentage; host?: Host; h?: Host; ip?: Ip; node?: string; n?: string; } export interface CatAllocationRequest extends CatCatRequestBase { node_id?: NodeIds; bytes?: Bytes; } export type CatAllocationResponse = CatAllocationAllocationRecord[]; export interface CatCountCountRecord { epoch?: EpochMillis; t?: EpochMillis; time?: EpochMillis; timestamp?: DateString; ts?: DateString; hms?: DateString; hhmmss?: DateString; count?: string; dc?: string; 'docs.count'?: string; docsCount?: string; } export interface CatCountRequest extends CatCatRequestBase { index?: Indices; } export type CatCountResponse = CatCountCountRecord[]; export interface CatFielddataFielddataRecord { id?: string; host?: string; h?: string; ip?: string; node?: string; n?: string; field?: string; f?: string; size?: string; } export interface CatFielddataRequest extends CatCatRequestBase { fields?: Fields; bytes?: Bytes; } export type CatFielddataResponse = CatFielddataFielddataRecord[]; export interface CatHealthHealthRecord { epoch?: EpochMillis; time?: EpochMillis; timestamp?: DateString; ts?: DateString; hms?: DateString; hhmmss?: DateString; cluster?: string; cl?: string; status?: string; st?: string; 'node.total'?: string; nt?: string; nodeTotal?: string; 'node.data'?: string; nd?: string; nodeData?: string; shards?: string; t?: string; sh?: string; 'shards.total'?: string; shardsTotal?: string; pri?: string; p?: string; 'shards.primary'?: string; shardsPrimary?: string; relo?: string; r?: string; 'shards.relocating'?: string; shardsRelocating?: string; init?: string; i?: string; 'shards.initializing'?: string; shardsInitializing?: string; unassign?: string; u?: string; 'shards.unassigned'?: string; shardsUnassigned?: string; pending_tasks?: string; pt?: string; pendingTasks?: string; max_task_wait_time?: string; mtwt?: string; maxTaskWaitTime?: string; active_shards_percent?: string; asp?: string; activeShardsPercent?: string; } export interface CatHealthRequest extends CatCatRequestBase { include_timestamp?: boolean; ts?: boolean; } export type CatHealthResponse = CatHealthHealthRecord[]; export interface CatHelpHelpRecord { endpoint: string; } export interface CatHelpRequest extends CatCatRequestBase { } export type CatHelpResponse = CatHelpHelpRecord[]; export interface CatIndicesIndicesRecord { health?: string; h?: string; status?: string; s?: string; index?: string; i?: string; idx?: string; uuid?: string; id?: string; pri?: string; p?: string; 'shards.primary'?: string; shardsPrimary?: string; rep?: string; r?: string; 'shards.replica'?: string; shardsReplica?: string; 'docs.count'?: string; dc?: string; docsCount?: string; 'docs.deleted'?: string; dd?: string; docsDeleted?: string; 'creation.date'?: string; cd?: string; 'creation.date.string'?: string; cds?: string; 'store.size'?: string; ss?: string; storeSize?: string; 'pri.store.size'?: string; 'completion.size'?: string; cs?: string; completionSize?: string; 'pri.completion.size'?: string; 'fielddata.memory_size'?: string; fm?: string; fielddataMemory?: string; 'pri.fielddata.memory_size'?: string; 'fielddata.evictions'?: string; fe?: string; fielddataEvictions?: string; 'pri.fielddata.evictions'?: string; 'query_cache.memory_size'?: string; qcm?: string; queryCacheMemory?: string; 'pri.query_cache.memory_size'?: string; 'query_cache.evictions'?: string; qce?: string; queryCacheEvictions?: string; 'pri.query_cache.evictions'?: string; 'request_cache.memory_size'?: string; rcm?: string; requestCacheMemory?: string; 'pri.request_cache.memory_size'?: string; 'request_cache.evictions'?: string; rce?: string; requestCacheEvictions?: string; 'pri.request_cache.evictions'?: string; 'request_cache.hit_count'?: string; rchc?: string; requestCacheHitCount?: string; 'pri.request_cache.hit_count'?: string; 'request_cache.miss_count'?: string; rcmc?: string; requestCacheMissCount?: string; 'pri.request_cache.miss_count'?: string; 'flush.total'?: string; ft?: string; flushTotal?: string; 'pri.flush.total'?: string; 'flush.total_time'?: string; ftt?: string; flushTotalTime?: string; 'pri.flush.total_time'?: string; 'get.current'?: string; gc?: string; getCurrent?: string; 'pri.get.current'?: string; 'get.time'?: string; gti?: string; getTime?: string; 'pri.get.time'?: string; 'get.total'?: string; gto?: string; getTotal?: string; 'pri.get.total'?: string; 'get.exists_time'?: string; geti?: string; getExistsTime?: string; 'pri.get.exists_time'?: string; 'get.exists_total'?: string; geto?: string; getExistsTotal?: string; 'pri.get.exists_total'?: string; 'get.missing_time'?: string; gmti?: string; getMissingTime?: string; 'pri.get.missing_time'?: string; 'get.missing_total'?: string; gmto?: string; getMissingTotal?: string; 'pri.get.missing_total'?: string; 'indexing.delete_current'?: string; idc?: string; indexingDeleteCurrent?: string; 'pri.indexing.delete_current'?: string; 'indexing.delete_time'?: string; idti?: string; indexingDeleteTime?: string; 'pri.indexing.delete_time'?: string; 'indexing.delete_total'?: string; idto?: string; indexingDeleteTotal?: string; 'pri.indexing.delete_total'?: string; 'indexing.index_current'?: string; iic?: string; indexingIndexCurrent?: string; 'pri.indexing.index_current'?: string; 'indexing.index_time'?: string; iiti?: string; indexingIndexTime?: string; 'pri.indexing.index_time'?: string; 'indexing.index_total'?: string; iito?: string; indexingIndexTotal?: string; 'pri.indexing.index_total'?: string; 'indexing.index_failed'?: string; iif?: string; indexingIndexFailed?: string; 'pri.indexing.index_failed'?: string; 'merges.current'?: string; mc?: string; mergesCurrent?: string; 'pri.merges.current'?: string; 'merges.current_docs'?: string; mcd?: string; mergesCurrentDocs?: string; 'pri.merges.current_docs'?: string; 'merges.current_size'?: string; mcs?: string; mergesCurrentSize?: string; 'pri.merges.current_size'?: string; 'merges.total'?: string; mt?: string; mergesTotal?: string; 'pri.merges.total'?: string; 'merges.total_docs'?: string; mtd?: string; mergesTotalDocs?: string; 'pri.merges.total_docs'?: string; 'merges.total_size'?: string; mts?: string; mergesTotalSize?: string; 'pri.merges.total_size'?: string; 'merges.total_time'?: string; mtt?: string; mergesTotalTime?: string; 'pri.merges.total_time'?: string; 'refresh.total'?: string; rto?: string; refreshTotal?: string; 'pri.refresh.total'?: string; 'refresh.time'?: string; rti?: string; refreshTime?: string; 'pri.refresh.time'?: string; 'refresh.external_total'?: string; reto?: string; 'pri.refresh.external_total'?: string; 'refresh.external_time'?: string; reti?: string; 'pri.refresh.external_time'?: string; 'refresh.listeners'?: string; rli?: string; refreshListeners?: string; 'pri.refresh.listeners'?: string; 'search.fetch_current'?: string; sfc?: string; searchFetchCurrent?: string; 'pri.search.fetch_current'?: string; 'search.fetch_time'?: string; sfti?: string; searchFetchTime?: string; 'pri.search.fetch_time'?: string; 'search.fetch_total'?: string; sfto?: string; searchFetchTotal?: string; 'pri.search.fetch_total'?: string; 'search.open_contexts'?: string; so?: string; searchOpenContexts?: string; 'pri.search.open_contexts'?: string; 'search.query_current'?: string; sqc?: string; searchQueryCurrent?: string; 'pri.search.query_current'?: string; 'search.query_time'?: string; sqti?: string; searchQueryTime?: string; 'pri.search.query_time'?: string; 'search.query_total'?: string; sqto?: string; searchQueryTotal?: string; 'pri.search.query_total'?: string; 'search.scroll_current'?: string; scc?: string; searchScrollCurrent?: string; 'pri.search.scroll_current'?: string; 'search.scroll_time'?: string; scti?: string; searchScrollTime?: string; 'pri.search.scroll_time'?: string; 'search.scroll_total'?: string; scto?: string; searchScrollTotal?: string; 'pri.search.scroll_total'?: string; 'segments.count'?: string; sc?: string; segmentsCount?: string; 'pri.segments.count'?: string; 'segments.memory'?: string; sm?: string; segmentsMemory?: string; 'pri.segments.memory'?: string; 'segments.index_writer_memory'?: string; siwm?: string; segmentsIndexWriterMemory?: string; 'pri.segments.index_writer_memory'?: string; 'segments.version_map_memory'?: string; svmm?: string; segmentsVersionMapMemory?: string; 'pri.segments.version_map_memory'?: string; 'segments.fixed_bitset_memory'?: string; sfbm?: string; fixedBitsetMemory?: string; 'pri.segments.fixed_bitset_memory'?: string; 'warmer.current'?: string; wc?: string; warmerCurrent?: string; 'pri.warmer.current'?: string; 'warmer.total'?: string; wto?: string; warmerTotal?: string; 'pri.warmer.total'?: string; 'warmer.total_time'?: string; wtt?: string; warmerTotalTime?: string; 'pri.warmer.total_time'?: string; 'suggest.current'?: string; suc?: string; suggestCurrent?: string; 'pri.suggest.current'?: string; 'suggest.time'?: string; suti?: string; suggestTime?: string; 'pri.suggest.time'?: string; 'suggest.total'?: string; suto?: string; suggestTotal?: string; 'pri.suggest.total'?: string; 'memory.total'?: string; tm?: string; memoryTotal?: string; 'pri.memory.total'?: string; 'search.throttled'?: string; sth?: string; 'bulk.total_operations'?: string; bto?: string; bulkTotalOperation?: string; 'pri.bulk.total_operations'?: string; 'bulk.total_time'?: string; btti?: string; bulkTotalTime?: string; 'pri.bulk.total_time'?: string; 'bulk.total_size_in_bytes'?: string; btsi?: string; bulkTotalSizeInBytes?: string; 'pri.bulk.total_size_in_bytes'?: string; 'bulk.avg_time'?: string; bati?: string; bulkAvgTime?: string; 'pri.bulk.avg_time'?: string; 'bulk.avg_size_in_bytes'?: string; basi?: string; bulkAvgSizeInBytes?: string; 'pri.bulk.avg_size_in_bytes'?: string; } export interface CatIndicesRequest extends CatCatRequestBase { index?: Indices; bytes?: Bytes; expand_wildcards?: ExpandWildcards; health?: Health; include_unloaded_segments?: boolean; pri?: boolean; } export type CatIndicesResponse = CatIndicesIndicesRecord[]; export interface CatClusterManagerClusterManagerRecord { id?: string host?: string h?: string ip?: string node?: string n?: string } /** * // TODO: delete CatMasterMasterRecord interface when it is removed from OpenSearch * @deprecated use CatClusterManagerClusterManagerRecord instead */ export interface CatMasterMasterRecord { id?: string; host?: string; h?: string; ip?: string; node?: string; n?: string; } export interface CatClusterManagerRequest extends CatCatRequestBase { } /** * // TODO: delete CatMasterRequest interface when it is removed from OpenSearch * @deprecated use CatClusterManagerRequest instead */ export interface CatMasterRequest extends CatCatRequestBase { } export type CatClusterManagerResponse = CatClusterManagerClusterManagerRecord[] /** * // TODO: delete CatMasterResponse type when it is removed from OpenSearch * @deprecated use CatClusterManagerResponse instead */ export type CatMasterResponse = CatMasterMasterRecord[] export interface CatNodeAttributesNodeAttributesRecord { node?: string; id?: string; pid?: string; host?: string; h?: string; ip?: string; i?: string; port?: string; attr?: string; value?: string; } export interface CatNodeAttributesRequest extends CatCatRequestBase { } export type CatNodeAttributesResponse = CatNodeAttributesNodeAttributesRecord[]; export interface CatNodesNodesRecord { id?: Id nodeId?: Id pid?: string p?: string ip?: string i?: string port?: string po?: string http_address?: string http?: string version?: VersionString v?: VersionString flavor?: string f?: string type?: Type t?: Type build?: string b?: string jdk?: string j?: string 'disk.total'?: ByteSize dt?: ByteSize diskTotal?: ByteSize 'disk.used'?: ByteSize du?: ByteSize diskUsed?: ByteSize 'disk.avail'?: ByteSize d?: ByteSize da?: ByteSize disk?: ByteSize diskAvail?: ByteSize 'disk.used_percent'?: Percentage dup?: Percentage diskUsedPercent?: Percentage 'heap.current'?: string hc?: string heapCurrent?: string 'heap.percent'?: Percentage hp?: Percentage heapPercent?: Percentage 'heap.max'?: string hm?: string heapMax?: string 'ram.current'?: string rc?: string ramCurrent?: string 'ram.percent'?: Percentage rp?: Percentage ramPercent?: Percentage 'ram.max'?: string rn?: string ramMax?: string 'file_desc.current'?: string fdc?: string fileDescriptorCurrent?: string 'file_desc.percent'?: Percentage fdp?: Percentage fileDescriptorPercent?: Percentage 'file_desc.max'?: string fdm?: string fileDescriptorMax?: string cpu?: string load_1m?: string load_5m?: string load_15m?: string l?: string uptime?: string u?: string 'node.role'?: string r?: string role?: string nodeRole?: string cluster_manager?: string /** * @deprecated use cluster_manager instead */ master?: string m?: string name?: Name n?: Name 'completion.size'?: string cs?: string completionSize?: string 'fielddata.memory_size'?: string fm?: string fielddataMemory?: string 'fielddata.evictions'?: string fe?: string fielddataEvictions?: string 'query_cache.memory_size'?: string qcm?: string queryCacheMemory?: string 'query_cache.evictions'?: string qce?: string queryCacheEvictions?: string 'query_cache.hit_count'?: string qchc?: string queryCacheHitCount?: string 'query_cache.miss_count'?: string qcmc?: string queryCacheMissCount?: string 'request_cache.memory_size'?: string rcm?: string requestCacheMemory?: string 'request_cache.evictions'?: string rce?: string requestCacheEvictions?: string 'request_cache.hit_count'?: string rchc?: string requestCacheHitCount?: string 'request_cache.miss_count'?: string rcmc?: string requestCacheMissCount?: string 'flush.total'?: string ft?: string flushTotal?: string 'flush.total_time'?: string ftt?: string flushTotalTime?: string 'get.current'?: string gc?: string getCurrent?: string 'get.time'?: string gti?: string getTime?: string 'get.total'?: string gto?: string getTotal?: string 'get.exists_time'?: string geti?: string getExistsTime?: string 'get.exists_total'?: string geto?: string getExistsTotal?: string 'get.missing_time'?: string gmti?: string getMissingTime?: string 'get.missing_total'?: string gmto?: string getMissingTotal?: string 'indexing.delete_current'?: string idc?: string indexingDeleteCurrent?: string 'indexing.delete_time'?: string idti?: string indexingDeleteTime?: string 'indexing.delete_total'?: string idto?: string indexingDeleteTotal?: string 'indexing.index_current'?: string iic?: string indexingIndexCurrent?: string 'indexing.index_time'?: string iiti?: string indexingIndexTime?: string 'indexing.index_total'?: string iito?: string indexingIndexTotal?: string 'indexing.index_failed'?: string iif?: string indexingIndexFailed?: string 'merges.current'?: string mc?: string mergesCurrent?: string 'merges.current_docs'?: string mcd?: string mergesCurrentDocs?: string 'merges.current_size'?: string mcs?: string mergesCurrentSize?: string 'merges.total'?: string mt?: string mergesTotal?: string 'merges.total_docs'?: string mtd?: string mergesTotalDocs?: string 'merges.total_size'?: string mts?: string mergesTotalSize?: string 'merges.total_time'?: string mtt?: string mergesTotalTime?: string 'refresh.total'?: string 'refresh.time'?: string 'refresh.external_total'?: string rto?: string refreshTotal?: string 'refresh.external_time'?: string rti?: string refreshTime?: string 'refresh.listeners'?: string rli?: string refreshListeners?: string 'script.compilations'?: string scrcc?: string scriptCompilations?: string 'script.cache_evictions'?: string scrce?: string scriptCacheEvictions?: string 'script.compilation_limit_triggered'?: string scrclt?: string scriptCacheCompilationLimitTriggered?: string 'search.fetch_current'?: string sfc?: string searchFetchCurrent?: string 'search.fetch_time'?: string sfti?: string searchFetchTime?: string 'search.fetch_total'?: string sfto?: string searchFetchTotal?: string 'search.open_contexts'?: string so?: string searchOpenContexts?: string 'search.query_current'?: string sqc?: string searchQueryCurrent?: string 'search.query_time'?: string sqti?: string searchQueryTime?: string 'search.query_total'?: string sqto?: string searchQueryTotal?: string 'search.scroll_current'?: string scc?: string searchScrollCurrent?: string 'search.scroll_time'?: string scti?: string searchScrollTime?: string 'search.scroll_total'?: string scto?: string searchScrollTotal?: string 'segments.count'?: string sc?: string segmentsCount?: string 'segments.memory'?: string sm?: string segmentsMemory?: string 'segments.index_writer_memory'?: string siwm?: string segmentsIndexWriterMemory?: string 'segments.version_map_memory'?: string svmm?: string segmentsVersionMapMemory?: string 'segments.fixed_bitset_memory'?: string sfbm?: string fixedBitsetMemory?: string 'suggest.current'?: string suc?: string suggestCurrent?: string 'suggest.time'?: string suti?: string suggestTime?: string 'suggest.total'?: string suto?: string suggestTotal?: string 'bulk.total_operations'?: string bto?: string bulkTotalOperations?: string 'bulk.total_time'?: string btti?: string bulkTotalTime?: string 'bulk.total_size_in_bytes'?: string btsi?: string bulkTotalSizeInBytes?: string 'bulk.avg_time'?: string bati?: string bulkAvgTime?: string 'bulk.avg_size_in_bytes'?: string basi?: string bulkAvgSizeInBytes?: string } export interface CatNodesRequest extends CatCatRequestBase { bytes?: Bytes; full_id?: boolean | string; } export type CatNodesResponse = CatNodesNodesRecord[]; export interface CatPendingTasksPendingTasksRecord { insertOrder?: string; o?: string; timeInQueue?: string; t?: string; priority?: string; p?: string; source?: string; s?: string; } export interface CatPendingTasksRequest extends CatCatRequestBase { } export type CatPendingTasksResponse = CatPendingTasksPendingTasksRecord[]; export interface CatPluginsPluginsRecord { id?: NodeId; name?: Name; n?: Name; component?: string; c?: string; version?: VersionString; v?: VersionString; description?: string; d?: string; type?: Type; t?: Type; } export interface CatPluginsRequest extends CatCatRequestBase { } export type CatPluginsResponse = CatPluginsPluginsRecord[]; export interface CatRecoveryRecoveryRecord { index?: IndexName; i?: IndexName; idx?: IndexName; shard?: string; s?: string; sh?: string; start_time?: string; start?: string; start_time_millis?: string; start_millis?: string; stop_time?: string; stop?: string; stop_time_millis?: string; stop_millis?: string; time?: string; t?: string; ti?: string; type?: Type; ty?: Type; stage?: string; st?: string; source_host?: string; shost?: string; source_node?: string; snode?: string; target_host?: string; thost?: string; target_node?: string; tnode?: string; repository?: string; rep?: string; snapshot?: string; snap?: string; files?: string; f?: string; files_recovered?: string; fr?: string; files_percent?: Percentage; fp?: Percentage; files_total?: string; tf?: string; bytes?: string; b?: string; bytes_recovered?: string; br?: string; bytes_percent?: Percentage; bp?: Percentage; bytes_total?: string; tb?: string; translog_ops?: string; to?: string; translog_ops_recovered?: string; tor?: string; translog_ops_percent?: Percentage; top?: Percentage; } export interface CatRecoveryRequest extends CatCatRequestBase { index?: Indices; active_only?: boolean; bytes?: Bytes; detailed?: boolean; } export type CatRecoveryResponse = CatRecoveryRecoveryRecord[]; export interface CatRepositoriesRepositoriesRecord { id?: string; repoId?: string; type?: string; t?: string; } export interface CatRepositoriesRequest extends CatCatRequestBase { } export type CatRepositoriesResponse = CatRepositoriesRepositoriesRecord[]; export interface CatSegmentsRequest extends CatCatRequestBase { index?: Indices; bytes?: Bytes; } export type CatSegmentsResponse = CatSegmentsSegmentsRecord[]; export interface CatSegmentsSegmentsRecord { index?: IndexName; i?: IndexName; idx?: IndexName; shard?: string; s?: string; sh?: string; prirep?: string; p?: string; pr?: string; primaryOrReplica?: string; ip?: string; id?: NodeId; segment?: string; seg?: string; generation?: string; g?: string; gen?: string; 'docs.count'?: string; dc?: string; docsCount?: string; 'docs.deleted'?: string; dd?: string; docsDeleted?: string; size?: ByteSize; si?: ByteSize; 'size.memory'?: ByteSize; sm?: ByteSize; sizeMemory?: ByteSize; committed?: string; ic?: string; isCommitted?: string; searchable?: string; is?: string; isSearchable?: string; version?: VersionString; v?: VersionString; compound?: string; ico?: string; isCompound?: string; } export interface CatShardsRequest extends CatCatRequestBase { index?: Indices; bytes?: Bytes; } export type CatShardsResponse = CatShardsShardsRecord[]; export interface CatShardsShardsRecord { index?: string; i?: string; idx?: string; shard?: string; s?: string; sh?: string; prirep?: string; p?: string; pr?: string; primaryOrReplica?: string; state?: string; st?: string; docs?: string; d?: string; dc?: string; store?: string; sto?: string; ip?: string; id?: string; node?: string; n?: string; sync_id?: string; 'unassigned.reason'?: string; ur?: string; 'unassigned.at'?: string; ua?: string; 'unassigned.for'?: string; uf?: string; 'unassigned.details'?: string; ud?: string; 'recoverysource.type'?: string; rs?: string; 'completion.size'?: string; cs?: string; completionSize?: string; 'fielddata.memory_size'?: string; fm?: string; fielddataMemory?: string; 'fielddata.evictions'?: string; fe?: string; fielddataEvictions?: string; 'query_cache.memory_size'?: string; qcm?: string; queryCacheMemory?: string; 'query_cache.evictions'?: string; qce?: string; queryCacheEvictions?: string; 'flush.total'?: string; ft?: string; flushTotal?: string; 'flush.total_time'?: string; ftt?: string; flushTotalTime?: string; 'get.current'?: string; gc?: string; getCurrent?: string; 'get.time'?: string; gti?: string; getTime?: string; 'get.total'?: string; gto?: string; getTotal?: string; 'get.exists_time'?: string; geti?: string; getExistsTime?: string; 'get.exists_total'?: string; geto?: string; getExistsTotal?: string; 'get.missing_time'?: string; gmti?: string; getMissingTime?: string; 'get.missing_total'?: string; gmto?: string; getMissingTotal?: string; 'indexing.delete_current'?: string; idc?: string; indexingDeleteCurrent?: string; 'indexing.delete_time'?: string; idti?: string; indexingDeleteTime?: string; 'indexing.delete_total'?: string; idto?: string; indexingDeleteTotal?: string; 'indexing.index_current'?: string; iic?: string; indexingIndexCurrent?: string; 'indexing.index_time'?: string; iiti?: string; indexingIndexTime?: string; 'indexing.index_total'?: string; iito?: string; indexingIndexTotal?: string; 'indexing.index_failed'?: string; iif?: string; indexingIndexFailed?: string; 'merges.current'?: string; mc?: string; mergesCurrent?: string; 'merges.current_docs'?: string; mcd?: string; mergesCurrentDocs?: string; 'merges.current_size'?: string; mcs?: string; mergesCurrentSize?: string; 'merges.total'?: string; mt?: string; mergesTotal?: string; 'merges.total_docs'?: string; mtd?: string; mergesTotalDocs?: string; 'merges.total_size'?: string; mts?: string; mergesTotalSize?: string; 'merges.total_time'?: string; mtt?: string; mergesTotalTime?: string; 'refresh.total'?: string; 'refresh.time'?: string; 'refresh.external_total'?: string; rto?: string; refreshTotal?: string; 'refresh.external_time'?: string; rti?: string; refreshTime?: string; 'refresh.listeners'?: string; rli?: string; refreshListeners?: string; 'search.fetch_current'?: string; sfc?: string; searchFetchCurrent?: string; 'search.fetch_time'?: string; sfti?: string; searchFetchTime?: string; 'search.fetch_total'?: string; sfto?: string; searchFetchTotal?: string; 'search.open_contexts'?: string; so?: string; searchOpenContexts?: string; 'search.query_current'?: string; sqc?: string; searchQueryCurrent?: string; 'search.query_time'?: string; sqti?: string; searchQueryTime?: string; 'search.query_total'?: string; sqto?: string; searchQueryTotal?: string; 'search.scroll_current'?: string; scc?: string; searchScrollCurrent?: string; 'search.scroll_time'?: string; scti?: string; searchScrollTime?: string; 'search.scroll_total'?: string; scto?: string; searchScrollTotal?: string; 'segments.count'?: string; sc?: string; segmentsCount?: string; 'segments.memory'?: string; sm?: string; segmentsMemory?: string; 'segments.index_writer_memory'?: string; siwm?: string; segmentsIndexWriterMemory?: string; 'segments.version_map_memory'?: string; svmm?: string; segmentsVersionMapMemory?: string; 'segments.fixed_bitset_memory'?: string; sfbm?: string; fixedBitsetMemory?: string; 'seq_no.max'?: string; sqm?: string; maxSeqNo?: string; 'seq_no.local_checkpoint'?: string; localCheckpoint?: string; 'seq_no.global_checkpoint'?: string; sqg?: string; globalCheckpoint?: string; 'warmer.current'?: string; wc?: string; warmerCurrent?: string; 'warmer.total'?: string; wto?: string; warmerTotal?: string; 'warmer.total_time'?: string; wtt?: string; warmerTotalTime?: string; 'path.data'?: string; pd?: string; dataPath?: string; 'path.state'?: string; ps?: string; statsPath?: string; 'bulk.total_operations'?: string; bto?: string; bulkTotalOperations?: string; 'bulk.total_time'?: string; btti?: string; bulkTotalTime?: string; 'bulk.total_size_in_bytes'?: string; btsi?: string; bulkTotalSizeInBytes?: string; 'bulk.avg_time'?: string; bati?: string; bulkAvgTime?: string; 'bulk.avg_size_in_bytes'?: string; basi?: string; bulkAvgSizeInBytes?: string; } export interface CatSnapshotsRequest extends CatCatRequestBase { repository?: Names; ignore_unavailable?: boolean; } export type CatSnapshotsResponse = CatSnapshotsSnapshotsRecord[]; export interface CatSnapshotsSnapshotsRecord { id?: string; snapshot?: string; repository?: string; re?: string; repo?: string; status?: string; s?: string; start_epoch?: EpochMillis; ste?: EpochMillis; startEpoch?: EpochMillis; start_time?: DateString; sti?: DateString; startTime?: DateString; end_epoch?: EpochMillis; ete?: EpochMillis; endEpoch?: EpochMillis; end_time?: DateString; eti?: DateString; endTime?: DateString; duration?: Time; dur?: Time; indices?: string; i?: string; successful_shards?: string; ss?: string; failed_shards?: string; fs?: string; total_shards?: string; ts?: string; reason?: string; r?: string; } export interface CatTasksRequest extends CatCatRequestBase { actions?: string[]; detailed?: boolean; node_id?: string[]; parent_task?: long; } export type CatTasksResponse = CatTasksTasksRecord[]; export interface CatTasksTasksRecord { id?: Id; action?: string; ac?: string; task_id?: Id; ti?: Id; parent_task_id?: string; pti?: string; type?: Type; ty?: Type; start_time?: string; start?: string; timestamp?: string; ts?: string; hms?: string; hhmmss?: string; running_time_ns?: string; running_time?: string; time?: string; node_id?: NodeId; ni?: NodeId; ip?: string; i?: string; port?: string; po?: string; node?: string; n?: string; version?: VersionString; v?: VersionString; x_opaque_id?: string; x?: string; description?: string; desc?: string; } export interface CatTemplatesRequest extends CatCatRequestBase { name?: Name; } export type CatTemplatesResponse = CatTemplatesTemplatesRecord[]; export interface CatTemplatesTemplatesRecord { name?: Name; n?: Name; index_patterns?: string; t?: string; order?: string; o?: string; p?: string; version?: VersionString; v?: VersionString; composed_of?: string; c?: string; } export interface CatThreadPoolRequest extends CatCatRequestBase { thread_pool_patterns?: Names; size?: Size | boolean; } export type CatThreadPoolResponse = CatThreadPoolThreadPoolRecord[]; export interface CatThreadPoolThreadPoolRecord { node_name?: string; nn?: string; node_id?: NodeId; id?: NodeId; ephemeral_node_id?: string; eid?: string; pid?: string; p?: string; host?: string; h?: string; ip?: string; i?: string; port?: string; po?: string; name?: string; n?: string; type?: string; t?: string; active?: string; a?: string; pool_size?: string; psz?: string; queue?: string; q?: string; queue_size?: string; qs?: string; rejected?: string; r?: string; largest?: string; l?: string; completed?: string; c?: string; core?: string; cr?: string; max?: string; mx?: string; size?: string; sz?: string; keep_alive?: string; ka?: string; } export interface ClusterClusterStateBlockIndex { description?: string; retryable?: boolean; levels?: string[]; aliases?: IndexAlias[]; aliases_version?: VersionNumber; version?: VersionNumber; mapping_version?: VersionNumber; settings_version?: VersionNumber; routing_num_shards?: VersionNumber; state?: string; settings?: Record; in_sync_allocations?: Record; primary_terms?: Record; mappings?: Record; rollover_info?: Record; timestamp_range?: Record; system?: boolean; } export interface ClusterClusterStateDeletedSnapshots { snapshot_deletions: string[]; } export interface ClusterClusterStateIndexLifecycle { policies: Record; operation_mode: LifecycleOperationMode; } export interface ClusterClusterStateIndexLifecyclePolicy { } export interface ClusterClusterStateIndexLifecycleSummary { policy: ClusterClusterStateIndexLifecyclePolicy; headers: HttpHeaders; version: VersionNumber; modified_date: long; modified_date_string: DateString; } export interface ClusterClusterStateIngest { pipeline: ClusterClusterStateIngestPipeline[]; } export interface ClusterClusterStateIngestPipeline { id: Id; config: ClusterClusterStateIngestPipelineConfig; } export interface ClusterClusterStateIngestPipelineConfig { description?: string; version?: VersionNumber; processors: IngestProcessorContainer[]; } export interface ClusterClusterStateMetadata { cluster_uuid: Uuid; cluster_uuid_committed: boolean; templates: ClusterClusterStateMetadataTemplate; indices?: Record; 'index-graveyard': ClusterClusterStateMetadataIndexGraveyard; cluster_coordination: ClusterClusterStateMetadataClusterCoordination; ingest?: ClusterClusterStateIngest; repositories?: Record; component_template?: Record; index_template?: Record; index_lifecycle?: ClusterClusterStateIndexLifecycle; } export interface ClusterClusterStateMetadataClusterCoordination { term: integer; last_committed_config: string[]; last_accepted_config: string[]; voting_config_exclusions: ClusterVotingConfigExclusionsItem[]; } export interface ClusterClusterStateMetadataIndexGraveyard { tombstones: ClusterTombstone[]; } export interface ClusterClusterStateMetadataTemplate { } export interface ClusterClusterStateRoutingNodes { unassigned: NodeShard[]; nodes: Record; } export interface ClusterClusterStateSnapshots { snapshots: SnapshotStatus[]; } export type ClusterClusterStatus = 'green' | 'yellow' | 'red'; export interface ClusterComponentTemplate { name: Name; component_template: ClusterComponentTemplateNode; } export interface ClusterComponentTemplateNode { template: ClusterComponentTemplateSummary; version?: VersionNumber; _meta?: Metadata; } export interface ClusterComponentTemplateSummary { _meta?: Metadata; version?: VersionNumber; settings: Record; mappings?: MappingTypeMapping; aliases?: Record; } export interface ClusterTombstone { index: ClusterTombstoneIndex; delete_date?: DateString; delete_date_in_millis: long; } export interface ClusterTombstoneIndex { index_name: Name; index_uuid: Uuid; } export interface ClusterVotingConfigExclusionsItem { node_id: Id; node_name: Name; } export interface ClusterAllocationExplainAllocationDecision { decider: string; decision: ClusterAllocationExplainAllocationExplainDecision; explanation: string; } export type ClusterAllocationExplainAllocationExplainDecision = | 'NO' | 'YES' | 'THROTTLE' | 'ALWAYS'; export interface ClusterAllocationExplainAllocationStore { allocation_id: string; found: boolean; in_sync: boolean; matching_size_in_bytes: long; matching_sync_id: boolean; store_exception: string; } export interface ClusterAllocationExplainClusterInfo { nodes: Record; shard_sizes: Record; shard_data_set_sizes?: Record; shard_paths: Record; reserved_sizes: ClusterAllocationExplainReservedSize[]; } export interface ClusterAllocationExplainCurrentNode { id: Id; name: Name; attributes: Record; transport_address: TransportAddress; weight_ranking: integer; } export type ClusterAllocationExplainDecision = | 'yes' | 'no' | 'worse_balance' | 'throttled' | 'awaiting_info' | 'allocation_delayed' | 'no_valid_shard_copy' | 'no_attempt'; export interface ClusterAllocationExplainDiskUsage { path: string; total_bytes: long; used_bytes: long; free_bytes: long; free_disk_percent: double; used_disk_percent: double; } export interface ClusterAllocationExplainNodeAllocationExplanation { deciders: ClusterAllocationExplainAllocationDecision[]; node_attributes: Record; node_decision: ClusterAllocationExplainDecision; node_id: Id; node_name: Name; store?: ClusterAllocationExplainAllocationStore; transport_address: TransportAddress; weight_ranking: integer; } export interface ClusterAllocationExplainNodeDiskUsage { node_name: Name; least_available: ClusterAllocationExplainDiskUsage; most_available: ClusterAllocationExplainDiskUsage; } export interface ClusterAllocationExplainRequest extends RequestBase { include_disk_info?: boolean; include_yes_decisions?: boolean; body?: { current_node?: string; index?: IndexName; primary?: boolean; shard?: integer; }; } export interface ClusterAllocationExplainReservedSize { node_id: Id; path: string; total: long; shards: string[]; } export interface ClusterAllocationExplainResponse { allocate_explanation?: string; allocation_delay?: string; allocation_delay_in_millis?: long; can_allocate?: ClusterAllocationExplainDecision; can_move_to_other_node?: ClusterAllocationExplainDecision; can_rebalance_cluster?: ClusterAllocationExplainDecision; can_rebalance_cluster_decisions?: ClusterAllocationExplainAllocationDecision[]; can_rebalance_to_other_node?: ClusterAllocationExplainDecision; can_remain_decisions?: ClusterAllocationExplainAllocationDecision[]; can_remain_on_current_node?: ClusterAllocationExplainDecision; cluster_info?: ClusterAllocationExplainClusterInfo; configured_delay?: string; configured_delay_in_millis?: long; current_node?: ClusterAllocationExplainCurrentNode; current_state: string; index: IndexName; move_explanation?: string; node_allocation_decisions?: ClusterAllocationExplainNodeAllocationExplanation[]; primary: boolean; rebalance_explanation?: string; remaining_delay?: string; remaining_delay_in_millis?: long; shard: integer; unassigned_info?: ClusterAllocationExplainUnassignedInformation; } export interface ClusterAllocationExplainUnassignedInformation { at: DateString; last_allocation_status?: string; reason: ClusterAllocationExplainUnassignedInformationReason; details?: string; failed_allocation_attempts?: integer; delayed?: boolean; allocation_status?: string; } export type ClusterAllocationExplainUnassignedInformationReason = | 'INDEX_CREATED' | 'CLUSTER_RECOVERED' | 'INDEX_REOPENED' | 'DANGLING_INDEX_IMPORTED' | 'NEW_INDEX_RESTORED' | 'EXISTING_INDEX_RESTORED' | 'REPLICA_ADDED' | 'ALLOCATION_FAILED' | 'NODE_LEFT' | 'REROUTE_CANCELLED' | 'REINITIALIZED' | 'REALLOCATED_REPLICA' | 'PRIMARY_FAILED' | 'FORCED_EMPTY_PRIMARY' | 'MANUAL_ALLOCATION'; export interface ClusterDeleteComponentTemplateRequest extends RequestBase { name: Name cluster_manager_timeout?: Time /** * @deprecated use cluster_manager_timeout instead */ master_timeout?: Time timeout?: Time } export interface ClusterDeleteComponentTemplateResponse extends AcknowledgedResponseBase { } export interface ClusterDeleteVotingConfigExclusionsRequest extends RequestBase { body?: { stub: string; }; } export interface ClusterDeleteVotingConfigExclusionsResponse { stub: integer; } export interface ClusterExistsComponentTemplateRequest extends RequestBase { stub_a: string; stub_b: string; body?: { stub_c: string; }; } export interface ClusterExistsComponentTemplateResponse { stub: integer; } export interface ClusterGetComponentTemplateRequest extends RequestBase { name?: Name flat_settings?: boolean local?: boolean cluster_manager_timeout?: Time /** * @deprecated use cluster_manager_timeout instead */ master_timeout?: Time } export interface ClusterGetComponentTemplateResponse { component_templates: ClusterComponentTemplate[]; } export interface ClusterGetSettingsRequest extends RequestBase { flat_settings?: boolean include_defaults?: boolean cluster_manager_timeout?: Time /** * @deprecated use cluster_manager_timeout instead */ master_timeout?: Time timeout?: Time } export interface ClusterGetSettingsResponse { persistent: Record; transient: Record; defaults?: Record; } export interface ClusterHealthIndexHealthStats { active_primary_shards: integer; active_shards: integer; initializing_shards: integer; number_of_replicas: integer; number_of_shards: integer; relocating_shards: integer; shards?: Record; status: Health; unassigned_shards: integer; } export interface ClusterHealthRequest extends RequestBase { index?: Indices expand_wildcards?: ExpandWildcards level?: Level local?: boolean cluster_manager_timeout?: Time /** * @deprecated use cluster_manager_timeout instead */ master_timeout?: Time timeout?: Time wait_for_active_shards?: WaitForActiveShards wait_for_events?: WaitForEvents wait_for_nodes?: string wait_for_no_initializing_shards?: boolean wait_for_no_relocating_shards?: boolean wait_for_status?: WaitForStatus } export interface ClusterHealthResponse { active_primary_shards: integer; active_shards: integer; active_shards_percent_as_number: Percentage; cluster_name: string; delayed_unassigned_shards: integer; indices?: Record; initializing_shards: integer; number_of_data_nodes: integer; number_of_in_flight_fetch: integer; number_of_nodes: integer; number_of_pending_tasks: integer; relocating_shards: integer; status: Health; task_max_waiting_in_queue_millis: EpochMillis; timed_out: boolean; unassigned_shards: integer; } export interface ClusterHealthShardHealthStats { active_shards: integer; initializing_shards: integer; primary_active: boolean; relocating_shards: integer; status: Health; unassigned_shards: integer; } export interface ClusterPendingTasksPendingTask { insert_order: integer; priority: string; source: string; time_in_queue: string; time_in_queue_millis: integer; } export interface ClusterPendingTasksRequest extends RequestBase { local?: boolean cluster_manager_timeout?: Time /** * @deprecated use cluster_manager_timeout instead */ master_timeout?: Time } export interface ClusterPendingTasksResponse { tasks: ClusterPendingTasksPendingTask[]; } export interface ClusterPutComponentTemplateRequest extends RequestBase { name: Name create?: boolean cluster_manager_timeout?: Time /** * @deprecated use cluster_manager_timeout instead */ master_timeout?: Time body?: { template: IndicesIndexState; aliases?: Record; mappings?: MappingTypeMapping; settings?: IndicesIndexSettings; version?: VersionNumber; _meta?: Metadata; }; } export interface ClusterPutComponentTemplateResponse extends AcknowledgedResponseBase { } export interface ClusterPutSettingsRequest extends RequestBase { flat_settings?: boolean cluster_manager_timeout?: Time /** * @deprecated use cluster_manager_timeout instead */ master_timeout?: Time timeout?: Time body?: { persistent?: Record; transient?: Record; }; } export interface ClusterPutSettingsResponse { acknowledged: boolean; persistent: Record; transient: Record; } export interface ClusterPutVotingConfigExclusionsRequest extends RequestBase { node_names?: Names; node_ids?: Ids; timeout?: Time; wait_for_removal?: boolean; } export interface ClusterPutVotingConfigExclusionsResponse { stub: integer; } export interface ClusterRemoteInfoClusterRemoteInfo { connected: boolean; initial_connect_timeout: Time; max_connections_per_cluster: integer; num_nodes_connected: long; seeds: string[]; skip_unavailable: boolean; } export interface ClusterRemoteInfoRequest extends RequestBase { body?: { stub: string; }; } export interface ClusterRemoteInfoResponse extends DictionaryResponseBase { } export interface ClusterRerouteCommand { cancel?: ClusterRerouteCommandCancelAction; move?: ClusterRerouteCommandMoveAction; allocate_replica?: ClusterRerouteCommandAllocateReplicaAction; allocate_stale_primary?: ClusterRerouteCommandAllocatePrimaryAction; allocate_empty_primary?: ClusterRerouteCommandAllocatePrimaryAction; } export interface ClusterRerouteCommandAllocatePrimaryAction { index: IndexName; shard: integer; node: string; accept_data_loss: boolean; } export interface ClusterRerouteCommandAllocateReplicaAction { index: IndexName; shard: integer; node: string; } export interface ClusterRerouteCommandCancelAction { index: IndexName; shard: integer; node: string; allow_primary?: boolean; } export interface ClusterRerouteCommandMoveAction { index: IndexName; shard: integer; from_node: string; to_node: string; } export interface ClusterRerouteRequest extends RequestBase { dry_run?: boolean explain?: boolean metric?: Metrics retry_failed?: boolean cluster_manager_timeout?: Time /** * @deprecated use cluster_manager_timeout instead */ master_timeout?: Time timeout?: Time body?: { commands?: ClusterRerouteCommand[]; }; } export interface ClusterRerouteRerouteDecision { decider: string; decision: string; explanation: string; } export interface ClusterRerouteRerouteExplanation { command: string; decisions: ClusterRerouteRerouteDecision[]; parameters: ClusterRerouteRerouteParameters; } export interface ClusterRerouteRerouteParameters { allow_primary: boolean; index: IndexName; node: NodeName; shard: integer; from_node?: NodeName; to_node?: NodeName; } export interface ClusterRerouteRerouteState { cluster_uuid: Uuid state_uuid?: Uuid cluster_manager_node?: string master_node?: string version?: VersionNumber blocks?: EmptyObject nodes?: Record routing_table?: Record routing_nodes?: ClusterClusterStateRoutingNodes security_tokens?: Record snapshots?: ClusterClusterStateSnapshots snapshot_deletions?: ClusterClusterStateDeletedSnapshots metadata?: ClusterClusterStateMetadata } export interface ClusterRerouteResponse extends AcknowledgedResponseBase { explanations?: ClusterRerouteRerouteExplanation[]; state: ClusterRerouteRerouteState; } export interface ClusterStateClusterStateBlocks { indices?: Record>; } export interface ClusterStateRequest extends RequestBase { metric?: Metrics index?: Indices allow_no_indices?: boolean expand_wildcards?: ExpandWildcards flat_settings?: boolean ignore_unavailable?: boolean local?: boolean cluster_manager_timeout?: Time /** * @deprecated use cluster_manager_timeout instead */ master_timeout?: Time wait_for_metadata_version?: VersionNumber wait_for_timeout?: Time } export interface ClusterStateResponse { cluster_name: Name cluster_uuid: Uuid cluster_manager_node?: string master_node?: string state?: string[] state_uuid?: Uuid version?: VersionNumber blocks?: ClusterStateClusterStateBlocks metadata?: ClusterClusterStateMetadata nodes?: Record routing_table?: Record routing_nodes?: ClusterClusterStateRoutingNodes snapshots?: ClusterClusterStateSnapshots snapshot_deletions?: ClusterClusterStateDeletedSnapshots } export interface ClusterStatsCharFilterTypes { char_filter_types: ClusterStatsFieldTypes[]; tokenizer_types: ClusterStatsFieldTypes[]; filter_types: ClusterStatsFieldTypes[]; analyzer_types: ClusterStatsFieldTypes[]; built_in_char_filters: ClusterStatsFieldTypes[]; built_in_tokenizers: ClusterStatsFieldTypes[]; built_in_filters: ClusterStatsFieldTypes[]; built_in_analyzers: ClusterStatsFieldTypes[]; } export interface ClusterStatsClusterFileSystem { available_in_bytes: long; free_in_bytes: long; total_in_bytes: long; } export interface ClusterStatsClusterIndices { completion: CompletionStats; count: long; docs: DocStats; fielddata: FielddataStats; query_cache: QueryCacheStats; segments: SegmentsStats; shards: ClusterStatsClusterIndicesShards; store: StoreStats; mappings: ClusterStatsFieldTypesMappings; analysis: ClusterStatsCharFilterTypes; versions?: ClusterStatsIndicesVersions[]; } export interface ClusterStatsClusterIndicesShards { index?: ClusterStatsClusterIndicesShardsIndex; primaries?: double; replication?: double; total?: double; } export interface ClusterStatsClusterIndicesShardsIndex { primaries: ClusterStatsClusterShardMetrics; replication: ClusterStatsClusterShardMetrics; shards: ClusterStatsClusterShardMetrics; } export interface ClusterStatsClusterIngest { number_of_pipelines: integer; processor_stats: Record; } export interface ClusterStatsClusterJvm { max_uptime_in_millis: long; mem: ClusterStatsClusterJvmMemory; threads: long; versions: ClusterStatsClusterJvmVersion[]; } export interface ClusterStatsClusterJvmMemory { heap_max_in_bytes: long; heap_used_in_bytes: long; } export interface ClusterStatsClusterJvmVersion { bundled_jdk: boolean; count: integer; using_bundled_jdk: boolean; version: VersionString; vm_name: string; vm_vendor: string; vm_version: VersionString; } export interface ClusterStatsClusterNetworkTypes { http_types: Record; transport_types: Record; } export interface ClusterStatsClusterNodeCount { coordinating_only: integer data: integer ingest: integer cluster_manager?: integer /** * @deprecated use cluster_manager instead */ master?: integer total: integer voting_only: integer remote_cluster_client: integer } export interface ClusterStatsClusterNodes { count: ClusterStatsClusterNodeCount; discovery_types: Record; fs: ClusterStatsClusterFileSystem; ingest: ClusterStatsClusterIngest; jvm: ClusterStatsClusterJvm; network_types: ClusterStatsClusterNetworkTypes; os: ClusterStatsClusterOperatingSystem; packaging_types: ClusterStatsNodePackagingType[]; plugins: PluginStats[]; process: ClusterStatsClusterProcess; versions: VersionString[]; } export interface ClusterStatsClusterOperatingSystem { allocated_processors: integer; available_processors: integer; mem: ClusterStatsOperatingSystemMemoryInfo; names: ClusterStatsClusterOperatingSystemName[]; pretty_names: ClusterStatsClusterOperatingSystemName[]; architectures?: ClusterStatsClusterOperatingSystemArchitecture[]; } export interface ClusterStatsClusterOperatingSystemArchitecture { count: integer; arch: string; } export interface ClusterStatsClusterOperatingSystemName { count: integer; name: Name; } export interface ClusterStatsClusterProcess { cpu: ClusterStatsClusterProcessCpu; open_file_descriptors: ClusterStatsClusterProcessOpenFileDescriptors; } export interface ClusterStatsClusterProcessCpu { percent: integer; } export interface ClusterStatsClusterProcessOpenFileDescriptors { avg: long; max: long; min: long; } export interface ClusterStatsClusterProcessor { count: long; current: long; failed: long; time_in_millis: long; } export interface ClusterStatsClusterShardMetrics { avg: double; max: double; min: double; } export interface ClusterStatsFieldTypes { name: Name; count: integer; index_count: integer; script_count?: integer; } export interface ClusterStatsFieldTypesMappings { field_types: ClusterStatsFieldTypes[]; runtime_field_types?: ClusterStatsRuntimeFieldTypes[]; } export interface ClusterStatsIndicesVersions { index_count: integer; primary_shard_count: integer; total_primary_bytes: long; version: VersionString; } export interface ClusterStatsNodePackagingType { count: integer; flavor: string; type: string; } export interface ClusterStatsOperatingSystemMemoryInfo { free_in_bytes: long; free_percent: integer; total_in_bytes: long; used_in_bytes: long; used_percent: integer; } export interface ClusterStatsRequest extends RequestBase { node_id?: NodeIds; flat_settings?: boolean; timeout?: Time; } export interface ClusterStatsResponse extends NodesNodesResponseBase { cluster_name: Name; cluster_uuid: Uuid; indices: ClusterStatsClusterIndices; nodes: ClusterStatsClusterNodes; status: ClusterClusterStatus; timestamp: long; } export interface ClusterStatsRuntimeFieldTypes { name: Name; count: integer; index_count: integer; scriptless_count: integer; shadowed_count: integer; lang: string[]; lines_max: integer; lines_total: integer; chars_max: integer; chars_total: integer; source_max: integer; source_total: integer; doc_max: integer; doc_total: integer; } export interface DanglingIndicesIndexDeleteRequest extends RequestBase { stub_a: string; stub_b: string; body?: { stub_c: string; }; } export interface DanglingIndicesIndexDeleteResponse { stub: integer; } export interface DanglingIndicesIndexImportRequest extends RequestBase { stub_a: string; stub_b: string; body?: { stub_c: string; }; } export interface DanglingIndicesIndexImportResponse { stub: integer; } export interface DanglingIndicesIndicesListRequest extends RequestBase { stub_a: string; stub_b: string; body?: { stub_c: string; }; } export interface DanglingIndicesIndicesListResponse { stub: integer; } export interface FeaturesGetFeaturesRequest extends RequestBase { stub_a: string; stub_b: string; body?: { stub_c: string; }; } export interface FeaturesGetFeaturesResponse { stub: integer; } export interface FeaturesResetFeaturesRequest extends RequestBase { stub_a: string; stub_b: string; body?: { stub_c: string; }; } export interface FeaturesResetFeaturesResponse { stub: integer; } export interface IndicesAlias { filter?: QueryDslQueryContainer; index_routing?: Routing; is_hidden?: boolean; is_write_index?: boolean; routing?: Routing; search_routing?: Routing; } export interface IndicesAliasDefinition { filter?: QueryDslQueryContainer; index_routing?: string; is_write_index?: boolean; routing?: string; search_routing?: string; } export type IndicesDataStreamHealthStatus = 'GREEN' | 'green' | 'YELLOW' | 'yellow' | 'RED' | 'red'; export interface IndicesFielddataFrequencyFilter { max: double; min: double; min_segment_size: integer; } export type IndicesIndexCheckOnStartup = 'false' | 'checksum' | 'true'; export interface IndicesIndexRouting { allocation?: IndicesIndexRoutingAllocation; rebalance?: IndicesIndexRoutingRebalance; } export interface IndicesIndexRoutingAllocation { enable?: IndicesIndexRoutingAllocationOptions; include?: IndicesIndexRoutingAllocationInclude; initial_recovery?: IndicesIndexRoutingAllocationInitialRecovery; disk?: IndicesIndexRoutingAllocationDisk; } export interface IndicesIndexRoutingAllocationDisk { threshold_enabled: boolean | string; } export interface IndicesIndexRoutingAllocationInclude { _tier_preference?: string; _id?: Id; } export interface IndicesIndexRoutingAllocationInitialRecovery { _id?: Id; } export type IndicesIndexRoutingAllocationOptions = 'all' | 'primaries' | 'new_primaries' | 'none'; export interface IndicesIndexRoutingRebalance { enable: IndicesIndexRoutingRebalanceOptions; } export type IndicesIndexRoutingRebalanceOptions = 'all' | 'primaries' | 'replicas' | 'none'; export interface IndicesIndexSettingBlocks { read_only?: boolean; 'index.blocks.read_only'?: boolean; read_only_allow_delete?: boolean; 'index.blocks.read_only_allow_delete'?: boolean; read?: boolean; 'index.blocks.read'?: boolean; write?: boolean | string; 'index.blocks.write'?: boolean | string; metadata?: boolean; 'index.blocks.metadata'?: boolean; } export interface IndicesIndexSettings { number_of_shards?: integer | string; 'index.number_of_shards'?: integer | string; number_of_replicas?: integer | string; 'index.number_of_replicas'?: integer | string; number_of_routing_shards?: integer; 'index.number_of_routing_shards'?: integer; check_on_startup?: IndicesIndexCheckOnStartup; 'index.check_on_startup'?: IndicesIndexCheckOnStartup; codec?: string; 'index.codec'?: string; routing_partition_size?: integer | string; 'index.routing_partition_size'?: integer | string; 'soft_deletes.retention_lease.period'?: Time; 'index.soft_deletes.retention_lease.period'?: Time; load_fixed_bitset_filters_eagerly?: boolean; 'index.load_fixed_bitset_filters_eagerly'?: boolean; hidden?: boolean | string; 'index.hidden'?: boolean | string; auto_expand_replicas?: string; 'index.auto_expand_replicas'?: string; 'search.idle.after'?: Time; 'index.search.idle.after'?: Time; refresh_interval?: Time; 'index.refresh_interval'?: Time; max_result_window?: integer; 'index.max_result_window'?: integer; max_inner_result_window?: integer; 'index.max_inner_result_window'?: integer; max_rescore_window?: integer; 'index.max_rescore_window'?: integer; max_docvalue_fields_search?: integer; 'index.max_docvalue_fields_search'?: integer; max_script_fields?: integer; 'index.max_script_fields'?: integer; max_ngram_diff?: integer; 'index.max_ngram_diff'?: integer; max_shingle_diff?: integer; 'index.max_shingle_diff'?: integer; blocks?: IndicesIndexSettingBlocks; 'index.blocks'?: IndicesIndexSettingBlocks; max_refresh_listeners?: integer; 'index.max_refresh_listeners'?: integer; 'analyze.max_token_count'?: integer; 'index.analyze.max_token_count'?: integer; 'highlight.max_analyzed_offset'?: integer; 'index.highlight.max_analyzed_offset'?: integer; max_terms_count?: integer; 'index.max_terms_count'?: integer; max_regex_length?: integer; 'index.max_regex_length'?: integer; routing?: IndicesIndexRouting; 'index.routing'?: IndicesIndexRouting; gc_deletes?: Time; 'index.gc_deletes'?: Time; default_pipeline?: PipelineName; 'index.default_pipeline'?: PipelineName; final_pipeline?: PipelineName; 'index.final_pipeline'?: PipelineName; lifecycle?: IndicesIndexSettingsLifecycle; 'index.lifecycle'?: IndicesIndexSettingsLifecycle; provided_name?: Name; 'index.provided_name'?: Name; creation_date?: DateString; 'index.creation_date'?: DateString; uuid?: Uuid; 'index.uuid'?: Uuid; version?: IndicesIndexVersioning; 'index.version'?: IndicesIndexVersioning; verified_before_close?: boolean | string; 'index.verified_before_close'?: boolean | string; format?: string | integer; 'index.format'?: string | integer; max_slices_per_scroll?: integer; 'index.max_slices_per_scroll'?: integer; 'translog.durability'?: string; 'index.translog.durability'?: string; 'query_string.lenient'?: boolean | string; 'index.query_string.lenient'?: boolean | string; priority?: integer | string; 'index.priority'?: integer | string; top_metrics_max_size?: integer; analysis?: IndicesIndexSettingsAnalysis; } export interface IndicesIndexSettingsAnalysis { char_filter?: Record; } export interface IndicesIndexSettingsLifecycle { name: Name; } export interface IndicesIndexState { aliases?: Record; mappings?: MappingTypeMapping; settings: IndicesIndexSettings | IndicesIndexStatePrefixedSettings; } export interface IndicesIndexStatePrefixedSettings { index: IndicesIndexSettings; } export interface IndicesIndexVersioning { created: VersionString; } export interface IndicesNumericFielddata { format: IndicesNumericFielddataFormat; } export type IndicesNumericFielddataFormat = 'array' | 'disabled'; export interface IndicesOverlappingIndexTemplate { name: Name; index_patterns?: IndexName[]; } export interface IndicesStringFielddata { format: IndicesStringFielddataFormat; } export type IndicesStringFielddataFormat = 'paged_bytes' | 'disabled'; export interface IndicesTemplateMapping { aliases: Record; index_patterns: Name[]; mappings: MappingTypeMapping; order: integer; settings: Record; version?: VersionNumber; } export type IndicesAddBlockIndicesBlockOptions = 'metadata' | 'read' | 'read_only' | 'write'; export interface IndicesAddBlockIndicesBlockStatus { name: IndexName; blocked: boolean; } export interface IndicesAddBlockRequest extends RequestBase { index: IndexName block: IndicesAddBlockIndicesBlockOptions allow_no_indices?: boolean expand_wildcards?: ExpandWildcards ignore_unavailable?: boolean cluster_manager_timeout?: Time /** * @deprecated use cluster_manager_timeout instead */ master_timeout?: Time timeout?: Time } export interface IndicesAddBlockResponse extends AcknowledgedResponseBase { shards_acknowledged: boolean; indices: IndicesAddBlockIndicesBlockStatus[]; } export interface IndicesAnalyzeAnalyzeDetail { analyzer?: IndicesAnalyzeAnalyzerDetail; charfilters?: IndicesAnalyzeCharFilterDetail[]; custom_analyzer: boolean; tokenfilters?: IndicesAnalyzeTokenDetail[]; tokenizer?: IndicesAnalyzeTokenDetail; } export interface IndicesAnalyzeAnalyzeToken { end_offset: long; position: long; position_length?: long; start_offset: long; token: string; type: string; } export interface IndicesAnalyzeAnalyzerDetail { name: string; tokens: IndicesAnalyzeExplainAnalyzeToken[]; } export interface IndicesAnalyzeCharFilterDetail { filtered_text: string[]; name: string; } export interface IndicesAnalyzeExplainAnalyzeToken { bytes: string; end_offset: long; keyword?: boolean; position: long; positionLength: long; start_offset: long; termFrequency: long; token: string; type: string; } export interface IndicesAnalyzeRequest extends RequestBase { index?: IndexName; body?: { analyzer?: string; attributes?: string[]; char_filter?: (string | AnalysisCharFilter)[]; explain?: boolean; field?: Field; filter?: (string | AnalysisTokenFilter)[]; normalizer?: string; text?: IndicesAnalyzeTextToAnalyze; tokenizer?: string | AnalysisTokenizer; }; } export interface IndicesAnalyzeResponse { detail?: IndicesAnalyzeAnalyzeDetail; tokens?: IndicesAnalyzeAnalyzeToken[]; } export type IndicesAnalyzeTextToAnalyze = string | string[]; export interface IndicesAnalyzeTokenDetail { name: string; tokens: IndicesAnalyzeExplainAnalyzeToken[]; } export interface IndicesClearCacheRequest extends RequestBase { index?: Indices; allow_no_indices?: boolean; expand_wildcards?: ExpandWildcards; fielddata?: boolean; fields?: Fields; ignore_unavailable?: boolean; query?: boolean; request?: boolean; } export interface IndicesClearCacheResponse extends ShardsOperationResponseBase { } export interface IndicesCloneRequest extends RequestBase { index: IndexName target: Name cluster_manager_timeout?: Time /** * @deprecated use cluster_manager_timeout instead */ master_timeout?: Time timeout?: Time wait_for_active_shards?: WaitForActiveShards body?: { aliases?: Record; settings?: Record; }; } export interface IndicesCloneResponse extends AcknowledgedResponseBase { index: IndexName; shards_acknowledged: boolean; } export interface IndicesCloseCloseIndexResult { closed: boolean; shards?: Record; } export interface IndicesCloseCloseShardResult { failures: ShardFailure[]; } export interface IndicesCloseRequest extends RequestBase { index: Indices allow_no_indices?: boolean expand_wildcards?: ExpandWildcards ignore_unavailable?: boolean cluster_manager_timeout?: Time /** * @deprecated use cluster_manager_timeout instead */ master_timeout?: Time timeout?: Time wait_for_active_shards?: WaitForActiveShards } export interface IndicesCloseResponse extends AcknowledgedResponseBase { indices: Record; shards_acknowledged: boolean; } export interface IndicesCreateRequest extends RequestBase { index: IndexName cluster_manager_timeout?: Time /** * @deprecated use cluster_manager_timeout instead */ master_timeout?: Time timeout?: Time wait_for_active_shards?: WaitForActiveShards body?: { aliases?: Record; mappings?: Record | MappingTypeMapping; settings?: Record; }; } export interface IndicesCreateResponse extends AcknowledgedResponseBase { index: IndexName; shards_acknowledged: boolean; } export interface IndicesDeleteRequest extends RequestBase { index: Indices allow_no_indices?: boolean expand_wildcards?: ExpandWildcards ignore_unavailable?: boolean cluster_manager_timeout?: Time /** * @deprecated use cluster_manager_timeout instead */ master_timeout?: Time timeout?: Time } export interface IndicesDeleteResponse extends IndicesResponseBase { } export interface IndicesDeleteAliasRequest extends RequestBase { index: Indices name: Names cluster_manager_timeout?: Time /** * @deprecated use cluster_manager_timeout instead */ master_timeout?: Time timeout?: Time } export interface IndicesDeleteAliasResponse extends AcknowledgedResponseBase { } export interface IndicesDeleteIndexTemplateRequest extends RequestBase { name: Name; } export interface IndicesDeleteIndexTemplateResponse extends AcknowledgedResponseBase { } export interface IndicesDeleteTemplateRequest extends RequestBase { name: Name cluster_manager_timeout?: Time /** * @deprecated use cluster_manager_timeout instead */ master_timeout?: Time timeout?: Time } export interface IndicesDeleteTemplateResponse extends AcknowledgedResponseBase { } export interface IndicesExistsRequest extends RequestBase { index: Indices; allow_no_indices?: boolean; expand_wildcards?: ExpandWildcards; flat_settings?: boolean; ignore_unavailable?: boolean; include_defaults?: boolean; local?: boolean; } export type IndicesExistsResponse = boolean; export interface IndicesExistsAliasRequest extends RequestBase { name: Names; index?: Indices; allow_no_indices?: boolean; expand_wildcards?: ExpandWildcards; ignore_unavailable?: boolean; local?: boolean; } export type IndicesExistsAliasResponse = boolean; export interface IndicesExistsIndexTemplateRequest extends RequestBase { name: Name cluster_manager_timeout?: Time /** * @deprecated use cluster_manager_timeout instead */ master_timeout?: Time } export type IndicesExistsIndexTemplateResponse = boolean; export interface IndicesExistsTemplateRequest extends RequestBase { name: Names flat_settings?: boolean local?: boolean cluster_manager_timeout?: Time /** * @deprecated use cluster_manager_timeout instead */ master_timeout?: Time } export type IndicesExistsTemplateResponse = boolean; export interface IndicesFlushRequest extends RequestBase { index?: Indices; allow_no_indices?: boolean; expand_wildcards?: ExpandWildcards; force?: boolean; ignore_unavailable?: boolean; wait_if_ongoing?: boolean; } export interface IndicesFlushResponse extends ShardsOperationResponseBase { } export interface IndicesForcemergeRequest extends RequestBase { index?: Indices; allow_no_indices?: boolean; expand_wildcards?: ExpandWildcards; flush?: boolean; ignore_unavailable?: boolean; max_num_segments?: long; only_expunge_deletes?: boolean; } export interface IndicesForcemergeResponse extends ShardsOperationResponseBase { } export interface IndicesGetRequest extends RequestBase { index: Indices allow_no_indices?: boolean expand_wildcards?: ExpandWildcards flat_settings?: boolean ignore_unavailable?: boolean include_defaults?: boolean local?: boolean cluster_manager_timeout?: Time /** * @deprecated use cluster_manager_timeout instead */ master_timeout?: Time } export interface IndicesGetResponse extends DictionaryResponseBase { } export interface IndicesGetAliasIndexAliases { aliases: Record; } export interface IndicesGetAliasRequest extends RequestBase { name?: Names; index?: Indices; allow_no_indices?: boolean; expand_wildcards?: ExpandWildcards; ignore_unavailable?: boolean; local?: boolean; } export interface IndicesGetAliasResponse extends DictionaryResponseBase { } export interface IndicesGetFieldMappingRequest extends RequestBase { fields: Fields; index?: Indices; allow_no_indices?: boolean; expand_wildcards?: ExpandWildcards; ignore_unavailable?: boolean; include_defaults?: boolean; local?: boolean; } export interface IndicesGetFieldMappingResponse extends DictionaryResponseBase { } export interface IndicesGetFieldMappingTypeFieldMappings { mappings: Record; } export interface IndicesGetIndexTemplateIndexTemplate { index_patterns: Name[]; composed_of: Name[]; template: IndicesGetIndexTemplateIndexTemplateSummary; version?: VersionNumber; priority?: long; _meta?: Metadata; allow_auto_create?: boolean; data_stream?: Record; } export interface IndicesGetIndexTemplateIndexTemplateItem { name: Name; index_template: IndicesGetIndexTemplateIndexTemplate; } export interface IndicesGetIndexTemplateIndexTemplateSummary { aliases?: Record; mappings?: MappingTypeMapping; settings?: Record; } export interface IndicesGetIndexTemplateRequest extends RequestBase { name?: Name; local?: boolean; body?: { flat_settings?: boolean cluster_manager_timeout?: Time /** * @deprecated use cluster_manager_timeout instead */ master_timeout?: Time } } export interface IndicesGetIndexTemplateResponse { index_templates: IndicesGetIndexTemplateIndexTemplateItem[]; } export interface IndicesGetMappingIndexMappingRecord { item?: MappingTypeMapping; mappings: MappingTypeMapping; } export interface IndicesGetMappingRequest extends RequestBase { index?: Indices allow_no_indices?: boolean expand_wildcards?: ExpandWildcards ignore_unavailable?: boolean local?: boolean cluster_manager_timeout?: Time /** * @deprecated use cluster_manager_timeout instead */ master_timeout?: Time } export interface IndicesGetMappingResponse extends DictionaryResponseBase { } export interface IndicesGetSettingsRequest extends RequestBase { index?: Indices name?: Names allow_no_indices?: boolean expand_wildcards?: ExpandWildcards flat_settings?: boolean ignore_unavailable?: boolean include_defaults?: boolean local?: boolean cluster_manager_timeout?: Time /** * @deprecated use cluster_manager_timeout instead */ master_timeout?: Time } export interface IndicesGetSettingsResponse extends DictionaryResponseBase { } export interface IndicesGetTemplateRequest extends RequestBase { name?: Names flat_settings?: boolean local?: boolean cluster_manager_timeout?: Time /** * @deprecated use cluster_manager_timeout instead */ master_timeout?: Time } export interface IndicesGetTemplateResponse extends DictionaryResponseBase { } export interface IndicesGetUpgradeRequest extends RequestBase { stub: string; } export interface IndicesGetUpgradeResponse { overlapping?: IndicesOverlappingIndexTemplate[]; template?: IndicesTemplateMapping; } export interface IndicesOpenRequest extends RequestBase { index: Indices allow_no_indices?: boolean expand_wildcards?: ExpandWildcards ignore_unavailable?: boolean cluster_manager_timeout?: Time /** * @deprecated use cluster_manager_timeout instead */ master_timeout?: Time timeout?: Time wait_for_active_shards?: WaitForActiveShards } export interface IndicesOpenResponse extends AcknowledgedResponseBase { shards_acknowledged: boolean; } export interface IndicesPutAliasRequest extends RequestBase { index: Indices name: Name cluster_manager_timeout?: Time /** * @deprecated use cluster_manager_timeout instead */ master_timeout?: Time timeout?: Time body?: { filter?: QueryDslQueryContainer; index_routing?: Routing; is_write_index?: boolean; routing?: Routing; search_routing?: Routing; }; } export interface IndicesPutAliasResponse extends AcknowledgedResponseBase { } export interface IndicesPutIndexTemplateIndexTemplateMapping { aliases?: Record; mappings?: MappingTypeMapping; settings?: IndicesIndexSettings; } export interface IndicesPutIndexTemplateRequest extends RequestBase { name: Name; body?: { index_patterns?: Indices; composed_of?: Name[]; template?: IndicesPutIndexTemplateIndexTemplateMapping; data_stream?: EmptyObject; priority?: integer; version?: VersionNumber; _meta?: Metadata; }; } export interface IndicesPutIndexTemplateResponse extends AcknowledgedResponseBase { } export interface IndicesPutMappingRequest extends RequestBase { index?: Indices allow_no_indices?: boolean expand_wildcards?: ExpandWildcards ignore_unavailable?: boolean cluster_manager_timeout?: Time /** * @deprecated use cluster_manager_timeout instead */ master_timeout?: Time timeout?: Time write_index_only?: boolean body?: { all_field?: MappingAllField; date_detection?: boolean; dynamic?: boolean | MappingDynamicMapping; dynamic_date_formats?: string[]; dynamic_templates?: | Record | Record[]; field_names_field?: MappingFieldNamesField; index_field?: MappingIndexField; meta?: Record; numeric_detection?: boolean; properties?: Record; routing_field?: MappingRoutingField; size_field?: MappingSizeField; source_field?: MappingSourceField; runtime?: MappingRuntimeFields; }; } export interface IndicesPutMappingResponse extends IndicesResponseBase { } export interface IndicesPutSettingsIndexSettingsBody extends IndicesIndexSettings { settings?: IndicesIndexSettings; } export interface IndicesPutSettingsRequest extends RequestBase { index?: Indices allow_no_indices?: boolean expand_wildcards?: ExpandWildcards flat_settings?: boolean ignore_unavailable?: boolean cluster_manager_timeout?: Time /** * @deprecated use cluster_manager_timeout instead */ master_timeout?: Time preserve_existing?: boolean timeout?: Time body?: IndicesPutSettingsIndexSettingsBody } export interface IndicesPutSettingsResponse extends AcknowledgedResponseBase { } export interface IndicesPutTemplateRequest extends RequestBase { name: Name create?: boolean flat_settings?: boolean cluster_manager_timeout?: Time /** * @deprecated use cluster_manager_timeout instead */ master_timeout?: Time timeout?: Time body?: { aliases?: Record; index_patterns?: string | string[]; mappings?: MappingTypeMapping; order?: integer; settings?: Record; version?: VersionNumber; }; } export interface IndicesPutTemplateResponse extends AcknowledgedResponseBase { } export interface IndicesRecoveryFileDetails { length: long; name: string; recovered: long; } export interface IndicesRecoveryRecoveryBytes { percent: Percentage; recovered?: ByteSize; recovered_in_bytes: ByteSize; reused?: ByteSize; reused_in_bytes: ByteSize; total?: ByteSize; total_in_bytes: ByteSize; } export interface IndicesRecoveryRecoveryFiles { details?: IndicesRecoveryFileDetails[]; percent: Percentage; recovered: long; reused: long; total: long; } export interface IndicesRecoveryRecoveryIndexStatus { bytes?: IndicesRecoveryRecoveryBytes; files: IndicesRecoveryRecoveryFiles; size: IndicesRecoveryRecoveryBytes; source_throttle_time?: Time; source_throttle_time_in_millis: EpochMillis; target_throttle_time?: Time; target_throttle_time_in_millis: EpochMillis; total_time_in_millis: EpochMillis; total_time?: Time; } export interface IndicesRecoveryRecoveryOrigin { hostname?: string; host?: Host; transport_address?: TransportAddress; id?: Id; ip?: Ip; name?: Name; bootstrap_new_history_uuid?: boolean; repository?: Name; snapshot?: Name; version?: VersionString; restoreUUID?: Uuid; index?: IndexName; } export interface IndicesRecoveryRecoveryStartStatus { check_index_time: long; total_time_in_millis: string; } export interface IndicesRecoveryRecoveryStatus { shards: IndicesRecoveryShardRecovery[]; } export interface IndicesRecoveryRequest extends RequestBase { index?: Indices; active_only?: boolean; detailed?: boolean; } export interface IndicesRecoveryResponse extends DictionaryResponseBase { } export interface IndicesRecoveryShardRecovery { id: long; index: IndicesRecoveryRecoveryIndexStatus; primary: boolean; source: IndicesRecoveryRecoveryOrigin; stage: string; start?: IndicesRecoveryRecoveryStartStatus; start_time?: DateString; start_time_in_millis: EpochMillis; stop_time?: DateString; stop_time_in_millis: EpochMillis; target: IndicesRecoveryRecoveryOrigin; total_time?: DateString; total_time_in_millis: EpochMillis; translog: IndicesRecoveryTranslogStatus; type: Type; verify_index: IndicesRecoveryVerifyIndex; } export interface IndicesRecoveryTranslogStatus { percent: Percentage; recovered: long; total: long; total_on_start: long; total_time?: string; total_time_in_millis: EpochMillis; } export interface IndicesRecoveryVerifyIndex { check_index_time?: Time; check_index_time_in_millis: EpochMillis; total_time?: Time; total_time_in_millis: EpochMillis; } export interface IndicesRefreshRequest extends RequestBase { index?: Indices; allow_no_indices?: boolean; expand_wildcards?: ExpandWildcards; ignore_unavailable?: boolean; } export interface IndicesRefreshResponse extends ShardsOperationResponseBase { } export interface IndicesResolveIndexRequest extends RequestBase { name: Names; expand_wildcards?: ExpandWildcards; } export interface IndicesResolveIndexResolveIndexAliasItem { name: Name; indices: Indices; } export interface IndicesResolveIndexResolveIndexDataStreamsItem { name: DataStreamName; timestamp_field: Field; backing_indices: Indices; } export interface IndicesResolveIndexResolveIndexItem { name: Name; aliases?: string[]; attributes: string[]; data_stream?: DataStreamName; } export interface IndicesResolveIndexResponse { indices: IndicesResolveIndexResolveIndexItem[]; aliases: IndicesResolveIndexResolveIndexAliasItem[]; data_streams: IndicesResolveIndexResolveIndexDataStreamsItem[]; } export interface IndicesRolloverRequest extends RequestBase { alias: IndexAlias new_index?: IndexName dry_run?: boolean cluster_manager_timeout?: Time /** * @deprecated use cluster_manager_timeout instead */ master_timeout?: Time timeout?: Time wait_for_active_shards?: WaitForActiveShards body?: { aliases?: Record; conditions?: IndicesRolloverRolloverConditions; mappings?: Record | MappingTypeMapping; settings?: Record; }; } export interface IndicesRolloverResponse extends AcknowledgedResponseBase { conditions: Record; dry_run: boolean; new_index: string; old_index: string; rolled_over: boolean; shards_acknowledged: boolean; } export interface IndicesRolloverRolloverConditions { max_age?: Time; max_docs?: long; max_size?: string; max_primary_shard_size?: ByteSize; } export interface IndicesSegmentsIndexSegment { shards: Record; } export interface IndicesSegmentsRequest extends RequestBase { index?: Indices; allow_no_indices?: boolean; expand_wildcards?: ExpandWildcards; ignore_unavailable?: boolean; verbose?: boolean; } export interface IndicesSegmentsResponse { indices: Record; _shards: ShardStatistics; } export interface IndicesSegmentsSegment { attributes: Record; committed: boolean; compound: boolean; deleted_docs: long; generation: integer; memory_in_bytes: double; search: boolean; size_in_bytes: double; num_docs: long; version: VersionString; } export interface IndicesSegmentsShardSegmentRouting { node: string; primary: boolean; state: string; } export interface IndicesSegmentsShardsSegment { num_committed_segments: integer; routing: IndicesSegmentsShardSegmentRouting; num_search_segments: integer; segments: Record; } export interface IndicesShardStoresIndicesShardStores { shards: Record; } export interface IndicesShardStoresRequest extends RequestBase { index?: Indices; allow_no_indices?: boolean; expand_wildcards?: ExpandWildcards; ignore_unavailable?: boolean; status?: string | string[]; } export interface IndicesShardStoresResponse { indices: Record; } export interface IndicesShardStoresShardStore { allocation: IndicesShardStoresShardStoreAllocation; allocation_id: Id; attributes: Record; id: Id; legacy_version: VersionNumber; name: Name; store_exception: IndicesShardStoresShardStoreException; transport_address: TransportAddress; } export type IndicesShardStoresShardStoreAllocation = 'primary' | 'replica' | 'unused'; export interface IndicesShardStoresShardStoreException { reason: string; type: string; } export interface IndicesShardStoresShardStoreWrapper { stores: IndicesShardStoresShardStore[]; } export interface IndicesShrinkRequest extends RequestBase { index: IndexName target: IndexName cluster_manager_timeout?: Time /** * @deprecated use cluster_manager_timeout instead */ master_timeout?: Time timeout?: Time wait_for_active_shards?: WaitForActiveShards body?: { aliases?: Record; settings?: Record; }; } export interface IndicesShrinkResponse extends AcknowledgedResponseBase { shards_acknowledged: boolean; index: IndexName; } export interface IndicesSimulateIndexTemplateRequest extends RequestBase { name?: Name; body?: { index_patterns?: IndexName[]; composed_of?: Name[]; overlapping?: IndicesOverlappingIndexTemplate[]; template?: IndicesTemplateMapping; }; } export interface IndicesSimulateIndexTemplateResponse { } export interface IndicesSimulateTemplateRequest extends RequestBase { name?: Name create?: boolean cluster_manager_timeout?: Time /** * @deprecated use cluster_manager_timeout instead */ master_timeout?: Time body?: IndicesGetIndexTemplateIndexTemplate } export interface IndicesSimulateTemplateResponse { stub: string; } export interface IndicesSplitRequest extends RequestBase { index: IndexName target: IndexName cluster_manager_timeout?: Time /** * @deprecated use cluster_manager_timeout instead */ master_timeout?: Time timeout?: Time wait_for_active_shards?: WaitForActiveShards body?: { aliases?: Record; settings?: Record; }; } export interface IndicesSplitResponse extends AcknowledgedResponseBase { shards_acknowledged: boolean; index: IndexName; } export interface IndicesStatsIndexStats { completion?: CompletionStats; docs?: DocStats; fielddata?: FielddataStats; flush?: FlushStats; get?: GetStats; indexing?: IndexingStats; merges?: MergesStats; query_cache?: QueryCacheStats; recovery?: RecoveryStats; refresh?: RefreshStats; request_cache?: RequestCacheStats; search?: SearchStats; segments?: SegmentsStats; store?: StoreStats; translog?: TranslogStats; warmer?: WarmerStats; bulk?: BulkStats; } export interface IndicesStatsIndicesStats { primaries: IndicesStatsIndexStats; shards?: Record; total: IndicesStatsIndexStats; uuid?: Uuid; } export interface IndicesStatsRequest extends RequestBase { metric?: Metrics; index?: Indices; completion_fields?: Fields; expand_wildcards?: ExpandWildcards; fielddata_fields?: Fields; fields?: Fields; forbid_closed_indices?: boolean; groups?: string | string[]; include_segment_file_sizes?: boolean; include_unloaded_segments?: boolean; level?: Level; types?: Types; } export interface IndicesStatsResponse { indices?: Record; _shards: ShardStatistics; _all: IndicesStatsIndicesStats; } export interface IndicesStatsShardCommit { generation: integer; id: Id; num_docs: long; user_data: Record; } export interface IndicesStatsShardFileSizeInfo { description: string; size_in_bytes: long; min_size_in_bytes?: long; max_size_in_bytes?: long; average_size_in_bytes?: long; count?: long; } export interface IndicesStatsShardLease { id: Id; retaining_seq_no: SequenceNumber; timestamp: long; source: string; } export interface IndicesStatsShardPath { data_path: string; is_custom_data_path: boolean; state_path: string; } export interface IndicesStatsShardQueryCache { cache_count: long; cache_size: long; evictions: long; hit_count: long; memory_size_in_bytes: long; miss_count: long; total_count: long; } export interface IndicesStatsShardRetentionLeases { primary_term: long; version: VersionNumber; leases: IndicesStatsShardLease[]; } export interface IndicesStatsShardRouting { node: string; primary: boolean; relocating_node?: string; state: IndicesStatsShardRoutingState; } export type IndicesStatsShardRoutingState = | 'UNASSIGNED' | 'INITIALIZING' | 'STARTED' | 'RELOCATING'; export interface IndicesStatsShardSequenceNumber { global_checkpoint: long; local_checkpoint: long; max_seq_no: SequenceNumber; } export interface IndicesStatsShardStats { commit: IndicesStatsShardCommit; completion: CompletionStats; docs: DocStats; fielddata: FielddataStats; flush: FlushStats; get: GetStats; indexing: IndexingStats; merges: MergesStats; shard_path: IndicesStatsShardPath; query_cache: IndicesStatsShardQueryCache; recovery: RecoveryStats; refresh: RefreshStats; request_cache: RequestCacheStats; retention_leases: IndicesStatsShardRetentionLeases; routing: IndicesStatsShardRouting; search: SearchStats; segments: SegmentsStats; seq_no: IndicesStatsShardSequenceNumber; store: StoreStats; translog: TranslogStats; warmer: WarmerStats; bulk?: BulkStats; } export interface IndicesUpdateAliasesIndicesUpdateAliasBulk { } export interface IndicesUpdateAliasesRequest extends RequestBase { cluster_manager_timeout?: Time /** * @deprecated use cluster_manager_timeout instead */ master_timeout?: Time timeout?: Time body?: { actions?: IndicesUpdateAliasesIndicesUpdateAliasBulk[]; }; } export interface IndicesUpdateAliasesResponse extends AcknowledgedResponseBase { } export interface IndicesUpgradeRequest extends RequestBase { stub_b: integer; stub_a: integer; body?: { stub_c: integer; }; } export interface IndicesUpgradeResponse { stub: integer; } export interface IndicesValidateQueryIndicesValidationExplanation { error?: string; explanation?: string; index: IndexName; valid: boolean; } export interface IndicesValidateQueryRequest extends RequestBase { index?: Indices; allow_no_indices?: boolean; all_shards?: boolean; analyzer?: string; analyze_wildcard?: boolean; default_operator?: DefaultOperator; df?: string; expand_wildcards?: ExpandWildcards; explain?: boolean; ignore_unavailable?: boolean; lenient?: boolean; query_on_query_string?: string; rewrite?: boolean; q?: string; body?: { query?: QueryDslQueryContainer; }; } export interface IndicesValidateQueryResponse { explanations?: IndicesValidateQueryIndicesValidationExplanation[]; _shards?: ShardStatistics; valid: boolean; error?: string; } export interface IngestAppendProcessor extends IngestProcessorBase { field: Field; value: any[]; allow_duplicates?: boolean; } export interface IngestAttachmentProcessor extends IngestProcessorBase { field: Field; ignore_missing?: boolean; indexed_chars?: long; indexed_chars_field?: Field; properties?: string[]; target_field?: Field; resource_name?: string; } export interface IngestBytesProcessor extends IngestProcessorBase { field: Field; ignore_missing?: boolean; target_field?: Field; } export interface IngestCircleProcessor extends IngestProcessorBase { error_distance: double; field: Field; ignore_missing: boolean; shape_type: IngestShapeType; target_field: Field; } export interface IngestConvertProcessor extends IngestProcessorBase { field: Field; ignore_missing?: boolean; target_field: Field; type: IngestConvertType; } export type IngestConvertType = | 'integer' | 'long' | 'float' | 'double' | 'string' | 'boolean' | 'auto'; export interface IngestCsvProcessor extends IngestProcessorBase { empty_value: any; description?: string; field: Field; ignore_missing?: boolean; quote?: string; separator?: string; target_fields: Fields; trim: boolean; } export interface IngestDateIndexNameProcessor extends IngestProcessorBase { date_formats: string[]; date_rounding: string | IngestDateRounding; field: Field; index_name_format: string; index_name_prefix: string; locale: string; timezone: string; } export interface IngestDateProcessor extends IngestProcessorBase { field: Field; formats: string[]; locale?: string; target_field?: Field; timezone?: string; } export type IngestDateRounding = 's' | 'm' | 'h' | 'd' | 'w' | 'M' | 'y'; export interface IngestDissectProcessor extends IngestProcessorBase { append_separator: string; field: Field; ignore_missing: boolean; pattern: string; } export interface IngestDotExpanderProcessor extends IngestProcessorBase { field: Field; path?: string; } export interface IngestDropProcessor extends IngestProcessorBase { } export interface IngestEnrichProcessor extends IngestProcessorBase { field: Field; ignore_missing?: boolean; max_matches?: integer; override?: boolean; policy_name: string; shape_relation?: GeoShapeRelation; target_field: Field; } export interface IngestFailProcessor extends IngestProcessorBase { message: string; } export interface IngestForeachProcessor extends IngestProcessorBase { field: Field; ignore_missing?: boolean; processor: IngestProcessorContainer; } export interface IngestGeoIpProcessor extends IngestProcessorBase { database_file: string; field: Field; first_only: boolean; ignore_missing: boolean; properties: string[]; target_field: Field; } export interface IngestGrokProcessor extends IngestProcessorBase { field: Field; ignore_missing?: boolean; pattern_definitions: Record; patterns: string[]; trace_match?: boolean; } export interface IngestGsubProcessor extends IngestProcessorBase { field: Field; ignore_missing?: boolean; pattern: string; replacement: string; target_field?: Field; } export interface IngestInferenceConfig { regression?: IngestInferenceConfigRegression; } export interface IngestInferenceConfigRegression { results_field: string; } export interface IngestInferenceProcessor extends IngestProcessorBase { model_id: Id; target_field: Field; field_map?: Record; inference_config?: IngestInferenceConfig; } export interface IngestJoinProcessor extends IngestProcessorBase { field: Field; separator: string; target_field?: Field; } export interface IngestJsonProcessor extends IngestProcessorBase { add_to_root: boolean; field: Field; target_field: Field; } export interface IngestKeyValueProcessor extends IngestProcessorBase { exclude_keys?: string[]; field: Field; field_split: string; ignore_missing?: boolean; include_keys?: string[]; prefix?: string; strip_brackets?: boolean; target_field?: Field; trim_key?: string; trim_value?: string; value_split: string; } export interface IngestLowercaseProcessor extends IngestProcessorBase { field: Field; ignore_missing?: boolean; target_field?: Field; } export interface IngestPipeline { description?: string; on_failure?: IngestProcessorContainer[]; processors?: IngestProcessorContainer[]; version?: VersionNumber; } export interface IngestPipelineConfig { description?: string; version?: VersionNumber; processors: IngestProcessorContainer[]; } export interface IngestPipelineProcessor extends IngestProcessorBase { name: Name; } export interface IngestProcessorBase { if?: string; ignore_failure?: boolean; on_failure?: IngestProcessorContainer[]; tag?: string; } export interface IngestProcessorContainer { attachment?: IngestAttachmentProcessor; append?: IngestAppendProcessor; csv?: IngestCsvProcessor; convert?: IngestConvertProcessor; date?: IngestDateProcessor; date_index_name?: IngestDateIndexNameProcessor; dot_expander?: IngestDotExpanderProcessor; fail?: IngestFailProcessor; foreach?: IngestForeachProcessor; json?: IngestJsonProcessor; user_agent?: IngestUserAgentProcessor; kv?: IngestKeyValueProcessor; geoip?: IngestGeoIpProcessor; grok?: IngestGrokProcessor; gsub?: IngestGsubProcessor; join?: IngestJoinProcessor; lowercase?: IngestLowercaseProcessor; remove?: IngestRemoveProcessor; rename?: IngestRenameProcessor; script?: Script; set?: IngestSetProcessor; sort?: IngestSortProcessor; split?: IngestSplitProcessor; trim?: IngestTrimProcessor; uppercase?: IngestUppercaseProcessor; urldecode?: IngestUrlDecodeProcessor; bytes?: IngestBytesProcessor; dissect?: IngestDissectProcessor; set_security_user?: IngestSetSecurityUserProcessor; pipeline?: IngestPipelineProcessor; drop?: IngestDropProcessor; circle?: IngestCircleProcessor; inference?: IngestInferenceProcessor; } export interface IngestRemoveProcessor extends IngestProcessorBase { field: Fields; ignore_missing?: boolean; } export interface IngestRenameProcessor extends IngestProcessorBase { field: Field; ignore_missing?: boolean; target_field: Field; } export interface IngestSetProcessor extends IngestProcessorBase { field: Field; override?: boolean; value: any; } export interface IngestSetSecurityUserProcessor extends IngestProcessorBase { field: Field; properties?: string[]; } export type IngestShapeType = 'geo_shape' | 'shape'; export interface IngestSortProcessor extends IngestProcessorBase { field: Field; order: SearchSortOrder; target_field: Field; } export interface IngestSplitProcessor extends IngestProcessorBase { field: Field; ignore_missing?: boolean; preserve_trailing?: boolean; separator: string; target_field?: Field; } export interface IngestTrimProcessor extends IngestProcessorBase { field: Field; ignore_missing?: boolean; target_field?: Field; } export interface IngestUppercaseProcessor extends IngestProcessorBase { field: Field; ignore_missing?: boolean; target_field?: Field; } export interface IngestUrlDecodeProcessor extends IngestProcessorBase { field: Field; ignore_missing?: boolean; target_field?: Field; } export interface IngestUserAgentProcessor extends IngestProcessorBase { field: Field; ignore_missing: boolean; options: IngestUserAgentProperty[]; regex_file: string; target_field: Field; } export type IngestUserAgentProperty = | 'NAME' | 'MAJOR' | 'MINOR' | 'PATCH' | 'OS' | 'OS_NAME' | 'OS_MAJOR' | 'OS_MINOR' | 'DEVICE' | 'BUILD'; export interface IngestDeletePipelineRequest extends RequestBase { id: Id cluster_manager_timeout?: Time /** * @deprecated use cluster_manager_timeout instead */ master_timeout?: Time timeout?: Time } export interface IngestDeletePipelineResponse extends AcknowledgedResponseBase { } export interface IngestGeoIpStatsGeoIpDownloadStatistics { successful_downloads: integer; failed_downloads: integer; total_download_time: integer; database_count: integer; skipped_updates: integer; } export interface IngestGeoIpStatsGeoIpNodeDatabaseName { name: Name; } export interface IngestGeoIpStatsGeoIpNodeDatabases { databases: IngestGeoIpStatsGeoIpNodeDatabaseName[]; files_in_temp: string[]; } export interface IngestGeoIpStatsRequest extends RequestBase { } export interface IngestGeoIpStatsResponse { stats: IngestGeoIpStatsGeoIpDownloadStatistics; nodes: Record; } export interface IngestGetPipelineRequest extends RequestBase { id?: Id cluster_manager_timeout?: Time /** * @deprecated use cluster_manager_timeout instead */ master_timeout?: Time summary?: boolean } export interface IngestGetPipelineResponse extends DictionaryResponseBase { } export interface IngestProcessorGrokRequest extends RequestBase { } export interface IngestProcessorGrokResponse { patterns: Record; } export interface IngestPutPipelineRequest extends RequestBase { id: Id cluster_manager_timeout?: Time /** * @deprecated use cluster_manager_timeout instead */ master_timeout?: Time timeout?: Time body?: { description?: string; on_failure?: IngestProcessorContainer[]; processors?: IngestProcessorContainer[]; version?: VersionNumber; }; } export interface IngestPutPipelineResponse extends AcknowledgedResponseBase { } export interface IngestSimulatePipelineDocument { _id?: Id; _index?: IndexName; _source: any; } export interface IngestSimulatePipelineDocumentSimulation { _id: Id; _index: IndexName; _ingest: IngestSimulatePipelineIngest; _parent?: string; _routing?: string; _source: Record; _type?: Type; } export interface IngestSimulatePipelineIngest { timestamp: DateString; pipeline?: Name; } export interface IngestSimulatePipelinePipelineSimulation { doc?: IngestSimulatePipelineDocumentSimulation; processor_results?: IngestSimulatePipelinePipelineSimulation[]; tag?: string; processor_type?: string; } export interface IngestSimulatePipelineRequest extends RequestBase { id?: Id; verbose?: boolean; body?: { docs?: IngestSimulatePipelineDocument[]; pipeline?: IngestPipeline; }; } export interface IngestSimulatePipelineResponse { docs: IngestSimulatePipelinePipelineSimulation[]; } export interface NodesAdaptiveSelection { avg_queue_size: long; avg_response_time: long; avg_response_time_ns: long; avg_service_time: string; avg_service_time_ns: long; outgoing_searches: long; rank: string; } export interface NodesBreaker { estimated_size: string; estimated_size_in_bytes: long; limit_size: string; limit_size_in_bytes: long; overhead: float; tripped: float; } export interface NodesCpu { percent: integer; sys?: string; sys_in_millis?: long; total?: string; total_in_millis?: long; user?: string; user_in_millis?: long; load_average?: Record; } export interface NodesDataPathStats { available: string; available_in_bytes: long; disk_queue: string; disk_reads: long; disk_read_size: string; disk_read_size_in_bytes: long; disk_writes: long; disk_write_size: string; disk_write_size_in_bytes: long; free: string; free_in_bytes: long; mount: string; path: string; total: string; total_in_bytes: long; type: string; } export interface NodesExtendedMemoryStats extends NodesMemoryStats { free_percent: integer; used_percent: integer; total_in_bytes: integer; free_in_bytes: integer; used_in_bytes: integer; } export interface NodesFileSystem { data: NodesDataPathStats[]; timestamp: long; total: NodesFileSystemTotal; } export interface NodesFileSystemTotal { available: string; available_in_bytes: long; free: string; free_in_bytes: long; total: string; total_in_bytes: long; } export interface NodesGarbageCollector { collectors: Record; } export interface NodesGarbageCollectorTotal { collection_count: long; collection_time: string; collection_time_in_millis: long; } export interface NodesHttp { current_open: integer; total_opened: long; } export interface NodesIngest { pipelines: Record; total: NodesIngestTotal; } export interface NodesIngestTotal { count: long; current: long; failed: long; processors: NodesKeyedProcessor[]; time_in_millis: long; } export interface NodesJvm { buffer_pools: Record; classes: NodesJvmClasses; gc: NodesGarbageCollector; mem: NodesMemoryStats; threads: NodesJvmThreads; timestamp: long; uptime: string; uptime_in_millis: long; } export interface NodesJvmClasses { current_loaded_count: long; total_loaded_count: long; total_unloaded_count: long; } export interface NodesJvmThreads { count: long; peak_count: long; } export interface NodesKeyedProcessor { statistics: NodesProcess; type: string; } export interface NodesMemoryStats { resident?: string; resident_in_bytes?: long; share?: string; share_in_bytes?: long; total_virtual?: string; total_virtual_in_bytes?: long; total_in_bytes: long; free_in_bytes: long; used_in_bytes: long; } export interface NodesNodeBufferPool { count: long; total_capacity: string; total_capacity_in_bytes: long; used: string; used_in_bytes: long; } export interface NodesNodesResponseBase { _nodes: NodeStatistics; } export interface NodesOperatingSystem { cpu: NodesCpu; mem: NodesExtendedMemoryStats; swap: NodesMemoryStats; timestamp: long; } export interface NodesProcess { cpu: NodesCpu; mem: NodesMemoryStats; open_file_descriptors: integer; timestamp: long; } export interface NodesScripting { cache_evictions: long; compilations: long; } export interface NodesStats { adaptive_selection: Record; breakers: Record; fs: NodesFileSystem; host: Host; http: NodesHttp; indices: IndicesStatsIndexStats; ingest: NodesIngest; ip: Ip | Ip[]; jvm: NodesJvm; name: Name; os: NodesOperatingSystem; process: NodesProcess; roles: NodeRoles; script: NodesScripting; thread_pool: Record; timestamp: long; transport: NodesTransport; transport_address: TransportAddress; attributes: Record; } export interface NodesThreadCount { active: long; completed: long; largest: long; queue: long; rejected: long; threads: long; } export interface NodesTransport { rx_count: long; rx_size: string; rx_size_in_bytes: long; server_open: integer; tx_count: long; tx_size: string; tx_size_in_bytes: long; } export interface NodesHotThreadsHotThread { hosts: Host[]; node_id: Id; node_name: Name; threads: string[]; } export interface NodesHotThreadsRequest extends RequestBase { node_id?: NodeIds; ignore_idle_threads?: boolean; interval?: Time; snapshots?: long; threads?: long; thread_type?: ThreadType; timeout?: Time; } export interface NodesHotThreadsResponse { hot_threads: NodesHotThreadsHotThread[]; } export interface NodesInfoNodeInfo { attributes: Record; build_hash: string; build_type: string; host: Host; http?: NodesInfoNodeInfoHttp; ip: Ip; jvm?: NodesInfoNodeJvmInfo; name: Name; network?: NodesInfoNodeInfoNetwork; os?: NodesInfoNodeOperatingSystemInfo; plugins?: PluginStats[]; process?: NodesInfoNodeProcessInfo; roles: NodeRoles; settings?: NodesInfoNodeInfoSettings; thread_pool?: Record; total_indexing_buffer?: long; total_indexing_buffer_in_bytes?: ByteSize; transport?: NodesInfoNodeInfoTransport; transport_address: TransportAddress; version: VersionString; modules?: PluginStats[]; ingest?: NodesInfoNodeInfoIngest; aggregations?: Record; } export interface NodesInfoNodeInfoAction { destructive_requires_name: string; } export interface NodesInfoNodeInfoAggregation { types: string[]; } export interface NodesInfoNodeInfoBootstrap { memory_lock: string; } export interface NodesInfoNodeInfoClient { type: string; } export interface NodesInfoNodeInfoDiscover { seed_hosts: string; } export interface NodesInfoNodeInfoHttp { bound_address: string[]; max_content_length?: ByteSize; max_content_length_in_bytes: long; publish_address: string; } export interface NodesInfoNodeInfoIngest { processors: NodesInfoNodeInfoIngestProcessor[]; } export interface NodesInfoNodeInfoIngestProcessor { type: string; } export interface NodesInfoNodeInfoJvmMemory { direct_max?: ByteSize; direct_max_in_bytes: long; heap_init?: ByteSize; heap_init_in_bytes: long; heap_max?: ByteSize; heap_max_in_bytes: long; non_heap_init?: ByteSize; non_heap_init_in_bytes: long; non_heap_max?: ByteSize; non_heap_max_in_bytes: long; } export interface NodesInfoNodeInfoMemory { total: string; total_in_bytes: long; } export interface NodesInfoNodeInfoNetwork { primary_interface: NodesInfoNodeInfoNetworkInterface; refresh_interval: integer; } export interface NodesInfoNodeInfoNetworkInterface { address: string; mac_address: string; name: Name; } export interface NodesInfoNodeInfoOSCPU { cache_size: string; cache_size_in_bytes: integer; cores_per_socket: integer; mhz: integer; model: string; total_cores: integer; total_sockets: integer; vendor: string; } export interface NodesInfoNodeInfoPath { logs: string; home: string; repo: string[]; data?: string[]; } export interface NodesInfoNodeInfoRepositories { url: NodesInfoNodeInfoRepositoriesUrl; } export interface NodesInfoNodeInfoRepositoriesUrl { allowed_urls: string; } export interface NodesInfoNodeInfoScript { allowed_types: string; disable_max_compilations_rate: string; } export interface NodesInfoNodeInfoSearch { remote: NodesInfoNodeInfoSearchRemote; } export interface NodesInfoNodeInfoSearchRemote { connect: string; } export interface NodesInfoNodeInfoSettings { cluster: NodesInfoNodeInfoSettingsCluster; node: NodesInfoNodeInfoSettingsNode; path: NodesInfoNodeInfoPath; repositories?: NodesInfoNodeInfoRepositories; discovery?: NodesInfoNodeInfoDiscover; action?: NodesInfoNodeInfoAction; client: NodesInfoNodeInfoClient; http: NodesInfoNodeInfoSettingsHttp; bootstrap?: NodesInfoNodeInfoBootstrap; transport: NodesInfoNodeInfoSettingsTransport; network?: NodesInfoNodeInfoSettingsNetwork; script?: NodesInfoNodeInfoScript; search?: NodesInfoNodeInfoSearch; } export interface NodesInfoNodeInfoSettingsCluster { name: Name routing?: IndicesIndexRouting election: NodesInfoNodeInfoSettingsClusterElection initial_cluster_manager_nodes?: string initial_master_nodes?: string } export interface NodesInfoNodeInfoSettingsClusterElection { strategy: Name; } export interface NodesInfoNodeInfoSettingsHttp { type: string | NodesInfoNodeInfoSettingsHttpType; 'type.default'?: string; compression?: boolean | string; port?: integer | string; } export interface NodesInfoNodeInfoSettingsHttpType { default: string; } export interface NodesInfoNodeInfoSettingsNetwork { host: Host; } export interface NodesInfoNodeInfoSettingsNode { name: Name; attr: Record; max_local_storage_nodes?: string; } export interface NodesInfoNodeInfoSettingsTransport { type: string | NodesInfoNodeInfoSettingsTransportType; 'type.default'?: string; features?: NodesInfoNodeInfoSettingsTransportFeatures; } export interface NodesInfoNodeInfoSettingsTransportFeatures { } export interface NodesInfoNodeInfoSettingsTransportType { default: string; } export interface NodesInfoNodeInfoTransport { bound_address: string[]; publish_address: string; profiles: Record; } export interface NodesInfoNodeJvmInfo { gc_collectors: string[]; mem: NodesInfoNodeInfoJvmMemory; memory_pools: string[]; pid: integer; start_time_in_millis: long; version: VersionString; vm_name: Name; vm_vendor: string; vm_version: VersionString; bundled_jdk: boolean; using_bundled_jdk: boolean; using_compressed_ordinary_object_pointers?: boolean | string; input_arguments: string[]; } export interface NodesInfoNodeOperatingSystemInfo { arch: string; available_processors: integer; allocated_processors?: integer; name: Name; pretty_name: Name; refresh_interval_in_millis: integer; version: VersionString; cpu?: NodesInfoNodeInfoOSCPU; mem?: NodesInfoNodeInfoMemory; swap?: NodesInfoNodeInfoMemory; } export interface NodesInfoNodeProcessInfo { id: long; mlockall: boolean; refresh_interval_in_millis: long; } export interface NodesInfoNodeThreadPoolInfo { core?: integer; keep_alive?: string; max?: integer; queue_size: integer; size?: integer; type: string; } export interface NodesInfoRequest extends RequestBase { node_id?: NodeIds metric?: Metrics flat_settings?: boolean cluster_manager_timeout?: Time /** * @deprecated use cluster_manager_timeout instead */ master_timeout?: Time timeout?: Time } export interface NodesInfoResponse extends NodesNodesResponseBase { cluster_name: Name; nodes: Record; } export interface NodesReloadSecureSettingsNodeReloadException { name: Name; reload_exception?: NodesReloadSecureSettingsNodeReloadExceptionCausedBy; } export interface NodesReloadSecureSettingsNodeReloadExceptionCausedBy { type: string; reason: string; caused_by?: NodesReloadSecureSettingsNodeReloadExceptionCausedBy; } export interface NodesReloadSecureSettingsRequest extends RequestBase { node_id?: NodeIds; timeout?: Time; body?: { secure_settings_password?: Password; }; } export interface NodesReloadSecureSettingsResponse extends NodesNodesResponseBase { cluster_name: Name; nodes: Record; } export interface NodesStatsRequest extends RequestBase { node_id?: NodeIds metric?: Metrics index_metric?: Metrics completion_fields?: Fields fielddata_fields?: Fields fields?: Fields groups?: boolean include_segment_file_sizes?: boolean level?: Level cluster_manager_timeout?: Time /** * @deprecated use cluster_manager_timeout instead */ master_timeout?: Time timeout?: Time types?: string[] include_unloaded_segments?: boolean } export interface NodesStatsResponse extends NodesNodesResponseBase { cluster_name: Name; nodes: Record; } export interface NodesUsageNodeUsage { rest_actions: Record; since: EpochMillis; timestamp: EpochMillis; aggregations: Record; } export interface NodesUsageRequest extends RequestBase { node_id?: NodeIds; metric?: Metrics; timeout?: Time; } export interface NodesUsageResponse extends NodesNodesResponseBase { cluster_name: Name; nodes: Record; } export interface ShutdownDeleteNodeRequest extends RequestBase { body?: { stub: string; }; } export interface ShutdownDeleteNodeResponse { stub: boolean; } export interface ShutdownGetNodeRequest extends RequestBase { body?: { stub: string; }; } export interface ShutdownGetNodeResponse { stub: boolean; } export interface ShutdownPutNodeRequest extends RequestBase { body?: { stub: string; }; } export interface ShutdownPutNodeResponse { stub: boolean; } export interface SnapshotFileCountSnapshotStats { file_count: integer; size_in_bytes: long; } export interface SnapshotIndexDetails { shard_count: integer; size?: ByteSize; size_in_bytes: long; max_segments_per_shard: long; } export interface SnapshotInfoFeatureState { feature_name: string; indices: Indices; } export interface SnapshotRepository { type: string; uuid?: Uuid; settings: SnapshotRepositorySettings; } export interface SnapshotRepositorySettings { chunk_size?: string; compress?: string | boolean; concurrent_streams?: string | integer; location: string; read_only?: string | boolean; readonly?: string | boolean; } export interface SnapshotShardsStats { done: long; failed: long; finalizing: long; initializing: long; started: long; total: long; } export type SnapshotShardsStatsStage = 'DONE' | 'FAILURE' | 'FINALIZE' | 'INIT' | 'STARTED'; export interface SnapshotShardsStatsSummary { incremental: SnapshotShardsStatsSummaryItem; total: SnapshotShardsStatsSummaryItem; start_time_in_millis: long; time_in_millis: long; } export interface SnapshotShardsStatsSummaryItem { file_count: long; size_in_bytes: long; } export interface SnapshotSnapshotIndexStats { shards: Record; shards_stats: SnapshotShardsStats; stats: SnapshotSnapshotStats; } export interface SnapshotSnapshotInfo { data_streams: string[]; duration?: Time; duration_in_millis?: EpochMillis; end_time?: Time; end_time_in_millis?: EpochMillis; failures?: SnapshotSnapshotShardFailure[]; include_global_state?: boolean; indices: IndexName[]; index_details?: Record; metadata?: Metadata; reason?: string; snapshot: Name; shards?: ShardStatistics; start_time?: Time; start_time_in_millis?: EpochMillis; state?: string; uuid: Uuid; version?: VersionString; version_id?: VersionNumber; feature_states?: SnapshotInfoFeatureState[]; } export interface SnapshotSnapshotShardFailure { index: IndexName; node_id: Id; reason: string; shard_id: Id; status: string; } export interface SnapshotSnapshotShardsStatus { stage: SnapshotShardsStatsStage; stats: SnapshotShardsStatsSummary; } export interface SnapshotSnapshotStats { incremental: SnapshotFileCountSnapshotStats; start_time_in_millis: long; time_in_millis: long; total: SnapshotFileCountSnapshotStats; } export interface SnapshotStatus { include_global_state: boolean; indices: Record; repository: string; shards_stats: SnapshotShardsStats; snapshot: string; state: string; stats: SnapshotSnapshotStats; uuid: Uuid; } export interface SnapshotCleanupRepositoryCleanupRepositoryResults { deleted_blobs: long; deleted_bytes: long; } export interface SnapshotCleanupRepositoryRequest extends RequestBase { repository: Name cluster_manager_timeout?: Time /** * @deprecated use cluster_manager_timeout instead */ master_timeout?: Time timeout?: Time } export interface SnapshotCleanupRepositoryResponse { results: SnapshotCleanupRepositoryCleanupRepositoryResults; } export interface SnapshotCloneRequest extends RequestBase { repository: Name snapshot: Name target_snapshot: Name cluster_manager_timeout?: Time /** * @deprecated use cluster_manager_timeout instead */ master_timeout?: Time timeout?: Time body?: { indices: string; }; } export interface SnapshotCloneResponse extends AcknowledgedResponseBase { } export interface SnapshotCreateRequest extends RequestBase { repository: Name snapshot: Name cluster_manager_timeout?: Time /** * @deprecated use cluster_manager_timeout instead */ master_timeout?: Time wait_for_completion?: boolean body?: { ignore_unavailable?: boolean; include_global_state?: boolean; indices?: Indices; metadata?: Metadata; partial?: boolean; }; } export interface SnapshotCreateResponse { accepted?: boolean; snapshot?: SnapshotSnapshotInfo; } export interface SnapshotCreateRepositoryRequest extends RequestBase { repository: Name cluster_manager_timeout?: Time /** * @deprecated use cluster_manager_timeout instead */ master_timeout?: Time timeout?: Time verify?: boolean body?: { repository?: SnapshotRepository; type: string; settings: SnapshotRepositorySettings; }; } export interface SnapshotCreateRepositoryResponse extends AcknowledgedResponseBase { } export interface SnapshotDeleteRequest extends RequestBase { repository: Name snapshot: Name cluster_manager_timeout?: Time /** * @deprecated use cluster_manager_timeout instead */ master_timeout?: Time } export interface SnapshotDeleteResponse extends AcknowledgedResponseBase { } export interface SnapshotDeleteRepositoryRequest extends RequestBase { repository: Names cluster_manager_timeout?: Time /** * @deprecated use cluster_manager_timeout instead */ master_timeout?: Time timeout?: Time } export interface SnapshotDeleteRepositoryResponse extends AcknowledgedResponseBase { } export interface SnapshotGetRequest extends RequestBase { repository: Name snapshot: Names ignore_unavailable?: boolean cluster_manager_timeout?: Time /** * @deprecated use cluster_manager_timeout instead */ master_timeout?: Time verbose?: boolean index_details?: boolean human?: boolean } export interface SnapshotGetResponse { responses?: SnapshotGetSnapshotResponseItem[]; snapshots?: SnapshotSnapshotInfo[]; } export interface SnapshotGetSnapshotResponseItem { repository: Name; snapshots?: SnapshotSnapshotInfo[]; error?: ErrorCause; } export interface SnapshotGetRepositoryRequest extends RequestBase { repository?: Names local?: boolean cluster_manager_timeout?: Time /** * @deprecated use cluster_manager_timeout instead */ master_timeout?: Time } export interface SnapshotGetRepositoryResponse extends DictionaryResponseBase { } export interface SnapshotRestoreRequest extends RequestBase { repository: Name snapshot: Name cluster_manager_timeout?: Time /** * @deprecated use cluster_manager_timeout instead */ master_timeout?: Time wait_for_completion?: boolean body?: { ignore_index_settings?: string[]; ignore_unavailable?: boolean; include_aliases?: boolean; include_global_state?: boolean; index_settings?: IndicesPutSettingsRequest; indices?: Indices; partial?: boolean; rename_pattern?: string; rename_replacement?: string; }; } export interface SnapshotRestoreResponse { snapshot: SnapshotRestoreSnapshotRestore; } export interface SnapshotRestoreSnapshotRestore { indices: IndexName[]; snapshot: string; shards: ShardStatistics; } export interface SnapshotStatusRequest extends RequestBase { repository?: Name snapshot?: Names ignore_unavailable?: boolean cluster_manager_timeout?: Time /** * @deprecated use cluster_manager_timeout instead */ master_timeout?: Time } export interface SnapshotStatusResponse { snapshots: SnapshotStatus[]; } export interface SnapshotVerifyRepositoryCompactNodeInfo { name: Name; } export interface SnapshotVerifyRepositoryRequest extends RequestBase { repository: Name cluster_manager_timeout?: Time /** * @deprecated use cluster_manager_timeout instead */ master_timeout?: Time timeout?: Time } export interface SnapshotVerifyRepositoryResponse { nodes: Record; } export interface TaskInfo { action: string; cancellable: boolean; children?: TaskInfo[]; description?: string; headers: HttpHeaders; id: long; node: string; running_time_in_nanos: long; start_time_in_millis: long; status?: TaskStatus; type: string; parent_task_id?: Id; } export interface TaskState { action: string; cancellable: boolean; description?: string; headers: HttpHeaders; id: long; node: string; parent_task_id?: TaskId; running_time_in_nanos: long; start_time_in_millis: long; status?: TaskStatus; type: string; } export interface TaskStatus { batches: long; canceled?: string; created: long; deleted: long; noops: long; failures?: string[]; requests_per_second: float; retries: Retries; throttled?: Time; throttled_millis: long; throttled_until?: Time; throttled_until_millis: long; timed_out?: boolean; took?: long; total: long; updated: long; version_conflicts: long; } export interface TaskTaskExecutingNode extends SpecUtilsBaseNode { tasks: Record; } export interface TaskCancelRequest extends RequestBase { task_id?: TaskId; actions?: string | string[]; nodes?: string[]; parent_task_id?: string; wait_for_completion?: boolean; } export interface TaskCancelResponse { node_failures?: ErrorCause[]; nodes: Record; } export interface TaskGetRequest extends RequestBase { task_id: Id; timeout?: Time; wait_for_completion?: boolean; } export interface TaskGetResponse { completed: boolean; task: TaskInfo; response?: TaskStatus; error?: ErrorCause; } export interface TaskListRequest extends RequestBase { actions?: string | string[]; detailed?: boolean; group_by?: GroupBy; nodes?: string[]; parent_task_id?: Id; timeout?: Time; wait_for_completion?: boolean; } export interface TaskListResponse { node_failures?: ErrorCause[]; nodes?: Record; tasks?: Record | TaskInfo[]; } export interface SpecUtilsAdditionalProperties { } export interface SpecUtilsCommonQueryParameters { error_trace?: boolean; filter_path?: string | string[]; human?: boolean; pretty?: boolean; source_query_string?: string; } export interface SpecUtilsCommonCatQueryParameters { format?: string h?: Names help?: boolean local?: boolean cluster_manager_timeout?: Time /** * @deprecated use cluster_manager_timeout instead */ master_timeout?: Time s?: string[] v?: boolean } export interface PointInTime { pit_id: string; creation_time: Time; keep_alive: Time } export interface PointInTimeDelete { pit_id: string; successful: boolean } export interface PointInTimeCreateRequest extends RequestBase { index: Indices; keep_alive: string; preference?: string; routing?: string; expand_wildcards?: ExpandWildcards; allow_partial_pit_creation?: boolean } export interface PointInTimeCreateResponse extends ShardsOperationResponseBase { pit_id: string; creation_time: Time; } export interface PointInTimeGetAllRequest extends RequestBase { } export interface PointInTimeGetAllResponse { pits: PointInTime[]; } export interface PointInTimeDeleteAllRequest extends RequestBase { } export interface PointInTimeDeleteAllResponse { pits: PointInTimeDelete[]; } export interface PointInTimeDeleteRequest extends RequestBase { body?: { pit_id: string[] }; } export interface PointInTimeDeleteResponse { pits: PointInTimeDelete[]; }